@wildboar/rose/src/lib/modules/Remote-Operations-Generic-ROS-PDUs/ReturnResult.ta.d.mts

Remote Operation Service Element PDUs in TypeScript

import { OPTIONAL, ASN1Element as _Element } from '@wildboar/asn1';
import * as $ from '@wildboar/asn1/functional';
import { InvokeId } from '../Remote-Operations-Generic-ROS-PDUs/InvokeId.ta.mjs';
import { ReturnResult_result } from '../Remote-Operations-Generic-ROS-PDUs/ReturnResult-result.ta.mjs';
/**
 * @summary ReturnResult
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * ReturnResult{OPERATION:Operations} ::= SEQUENCE {
 *   invokeId
 *     InvokeId
 *       (CONSTRAINED BY {-- must be that for an outstanding operation -- } !
 *        RejectProblem:returnResult-unrecognizedInvocation)
 *       (CONSTRAINED BY {-- which returns a result -- } !
 *        RejectProblem:returnResult-resultResponseUnexpected),
 *   result
 *     SEQUENCE {opcode
 *                 OPERATION.&operationCode({Operations})
 *                   (CONSTRAINED BY {-- identified by invokeId -- } !
 *                    RejectProblem:returnResult-unrecognizedInvocation),
 *               result
 *                 OPERATION.&ResultType
 *                   ({Operations}{@.opcode} !
 *                    RejectProblem:returnResult-mistypedResult)} OPTIONAL
 * }
 * (CONSTRAINED BY { -- must conform to the above definition --} !
 *  RejectProblem:general-mistypedPDU)
 * ```
 *
 */
export declare class ReturnResult {
    /**
     * @summary `invokeId`.
     * @public
     * @readonly
     */
    readonly invokeId: InvokeId;
    /**
     * @summary `result`.
     * @public
     * @readonly
     */
    readonly result: OPTIONAL<ReturnResult_result>;
    constructor(
    /**
     * @summary `invokeId`.
     * @public
     * @readonly
     */
    invokeId: InvokeId, 
    /**
     * @summary `result`.
     * @public
     * @readonly
     */
    result: OPTIONAL<ReturnResult_result>);
    /**
     * @summary Restructures an object into a ReturnResult
     * @description
     *
     * This takes an `object` and converts it to a `ReturnResult`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `ReturnResult`.
     * @returns {ReturnResult}
     */
    static _from_object(_o: {
        [_K in keyof ReturnResult]: ReturnResult[_K];
    }): ReturnResult;
}
/**
 * @summary The Leading Root Component Types of ReturnResult
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the leading root component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _root_component_type_list_1_spec_for_ReturnResult: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of ReturnResult
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the trailing root component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _root_component_type_list_2_spec_for_ReturnResult: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of ReturnResult
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the extension addition component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _extension_additions_list_spec_for_ReturnResult: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) ReturnResult
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {ReturnResult} The decoded data structure.
 */
export declare function _decode_ReturnResult(el: _Element): ReturnResult;
/**
 * @summary Encodes a(n) ReturnResult into an ASN.1 Element.
 * @function
 * @param value The element being encoded.
 * @param elGetter A function that can be used to get new ASN.1 elements.
 * @returns {_Element} The ReturnResult, encoded as an ASN.1 Element.
 */
export declare function _encode_ReturnResult(value: ReturnResult, elGetter: $.ASN1Encoder<ReturnResult>): _Element;
//# sourceMappingURL=ReturnResult.ta.d.mts.map