@wildboar/rose/src/lib/modules/Remote-Operations-Generic-ROS-PDUs/Invoke.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 { Invoke_linkedId } from '../Remote-Operations-Generic-ROS-PDUs/Invoke-linkedId.ta.mjs';
import { Code } from '../Remote-Operations-Information-Objects/Code.ta.mjs';
/**
 * @summary Invoke
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * Invoke{InvokeId:InvokeIdSet, OPERATION:Operations} ::= SEQUENCE {
 *   invokeId
 *     InvokeId(InvokeIdSet)
 *       (CONSTRAINED BY {-- must be unambiguous -- } !
 *        RejectProblem:invoke-duplicateInvocation),
 *   linkedId
 *     CHOICE {present  [0] IMPLICIT present < InvokeId,
 *             absent   [1] IMPLICIT NULL
 *   }
 *   (CONSTRAINED BY { -- must identify an outstanding operation --} !
 *    RejectProblem:invoke-unrecognizedLinkedId)
 *   (CONSTRAINED BY { -- which has one or more linked operations--} !
 *    RejectProblem:invoke-linkedResponseUnexpected) OPTIONAL,
 *   opcode
 *     OPERATION.&operationCode
 *       ({Operations} !RejectProblem:invoke-unrecognizedOperation),
 *   argument
 *     OPERATION.&ArgumentType
 *       ({Operations}{@opcode} !RejectProblem:invoke-mistypedArgument) OPTIONAL
 * }
 * (CONSTRAINED BY { -- must conform to the above definition --} !
 *  RejectProblem:general-mistypedPDU)
 * (WITH COMPONENTS {
 *    ...,
 *    linkedId  ABSENT
 *  } |
 *  WITH COMPONENTS {
 *    ...,
 *    linkedId  PRESENT,
 *    opcode    (CONSTRAINED BY { -- must be in the &Linked field of the associated operation --
 *                 } !RejectProblem:invoke-unexpectedLinkedOperation)
 *  })
 * ```
 *
 */
export declare class Invoke {
    /**
     * @summary `invokeId`.
     * @public
     * @readonly
     */
    readonly invokeId: InvokeId;
    /**
     * @summary `linkedId`.
     * @public
     * @readonly
     */
    readonly linkedId: OPTIONAL<Invoke_linkedId>;
    /**
     * @summary `opcode`.
     * @public
     * @readonly
     */
    readonly opcode: Code;
    /**
     * @summary `argument`.
     * @public
     * @readonly
     */
    readonly argument: OPTIONAL<_Element>;
    constructor(
    /**
     * @summary `invokeId`.
     * @public
     * @readonly
     */
    invokeId: InvokeId, 
    /**
     * @summary `linkedId`.
     * @public
     * @readonly
     */
    linkedId: OPTIONAL<Invoke_linkedId>, 
    /**
     * @summary `opcode`.
     * @public
     * @readonly
     */
    opcode: Code, 
    /**
     * @summary `argument`.
     * @public
     * @readonly
     */
    argument: OPTIONAL<_Element>);
    /**
     * @summary Restructures an object into a Invoke
     * @description
     *
     * This takes an `object` and converts it to a `Invoke`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `Invoke`.
     * @returns {Invoke}
     */
    static _from_object(_o: {
        [_K in keyof Invoke]: Invoke[_K];
    }): Invoke;
}
/**
 * @summary The Leading Root Component Types of Invoke
 * @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_Invoke: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of Invoke
 * @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_Invoke: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of Invoke
 * @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_Invoke: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) Invoke
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {Invoke} The decoded data structure.
 */
export declare function _decode_Invoke(el: _Element): Invoke;
/**
 * @summary Encodes a(n) Invoke 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 Invoke, encoded as an ASN.1 Element.
 */
export declare function _encode_Invoke(value: Invoke, elGetter: $.ASN1Encoder<Invoke>): _Element;
//# sourceMappingURL=Invoke.ta.d.mts.map