@wildboar/acse
Version:
Association Control Service Element PDUs in TypeScript
365 lines • 11.6 kB
text/typescript
import { OPTIONAL, ASN1Element as _Element } from '@wildboar/asn1';
import * as $ from '@wildboar/asn1/functional';
import { AARQ_apdu_protocol_version } from '../ACSE-1/AARQ-apdu-protocol-version.ta.mjs';
import { ASO_context_name } from '../ACSE-1/ASO-context-name.ta.mjs';
import { AP_title } from '../ACSE-1/AP-title.ta.mjs';
import { AE_qualifier } from '../ACSE-1/AE-qualifier.ta.mjs';
import { AP_invocation_identifier } from '../ACSE-1/AP-invocation-identifier.ta.mjs';
import { AE_invocation_identifier } from '../ACSE-1/AE-invocation-identifier.ta.mjs';
import { ACSE_requirements } from '../ACSE-1/ACSE-requirements.ta.mjs';
import { Mechanism_name } from '../ACSE-1/Mechanism-name.ta.mjs';
import { Authentication_value } from '../ACSE-1/Authentication-value.ta.mjs';
import { ASO_context_name_list } from '../ACSE-1/ASO-context-name-list.ta.mjs';
import { Implementation_data } from '../ACSE-1/Implementation-data.ta.mjs';
import { Association_data } from '../ACSE-1/Association-data.ta.mjs';
import { Syntactic_context_list } from '../ACSE-1/Syntactic-context-list.ta.mjs';
import { ASOI_tag } from '../ACSE-1/ASOI-tag.ta.mjs';
/**
* @summary AARQ_apdu
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* AARQ-apdu ::= [APPLICATION 0] IMPLICIT SEQUENCE {
* protocol-version
* [0] IMPLICIT BIT STRING {version1(0)} DEFAULT {version1},
* aSO-context-name [1] ASO-context-name,
* called-AP-title [2] AP-title OPTIONAL,
* called-AE-qualifier [3] AE-qualifier OPTIONAL,
* called-AP-invocation-identifier [4] AP-invocation-identifier OPTIONAL,
* called-AE-invocation-identifier [5] AE-invocation-identifier OPTIONAL,
* calling-AP-title [6] AP-title OPTIONAL,
* calling-AE-qualifier [7] AE-qualifier OPTIONAL,
* calling-AP-invocation-identifier [8] AP-invocation-identifier OPTIONAL,
* calling-AE-invocation-identifier [9] AE-invocation-identifier OPTIONAL,
* -- The following field shall not be present if only the Kernel is used.
* sender-acse-requirements [10] IMPLICIT ACSE-requirements OPTIONAL,
* -- The following field shall only be present if the Authentication functional unit is selected.
* mechanism-name [11] IMPLICIT Mechanism-name OPTIONAL,
* -- The following field shall only be present if the Authentication functional unit is selected.
* calling-authentication-value [12] EXPLICIT Authentication-value OPTIONAL,
* aSO-context-name-list
* [13] IMPLICIT ASO-context-name-list OPTIONAL,
* -- The above field shall only be present if the Application Context Negotiation functional unit is selected.
* implementation-information [29] IMPLICIT Implementation-data OPTIONAL,
* ...,
* -- Extensions for higher level association FU
* p-context-definition-list [14] Syntactic-context-list OPTIONAL,
* called-asoi-tag [15] IMPLICIT ASOI-tag OPTIONAL,
* calling-asoi-tag [16] IMPLICIT ASOI-tag OPTIONAL,
* -- End of extensions for higher level association FU
* ...,
* user-information [30] IMPLICIT Association-data OPTIONAL
* }
* ```
*
*/
export declare class AARQ_apdu {
/**
* @summary `protocol_version`.
* @public
* @readonly
*/
readonly protocol_version: OPTIONAL<AARQ_apdu_protocol_version>;
/**
* @summary `aSO_context_name`.
* @public
* @readonly
*/
readonly aSO_context_name: ASO_context_name;
/**
* @summary `called_AP_title`.
* @public
* @readonly
*/
readonly called_AP_title: OPTIONAL<AP_title>;
/**
* @summary `called_AE_qualifier`.
* @public
* @readonly
*/
readonly called_AE_qualifier: OPTIONAL<AE_qualifier>;
/**
* @summary `called_AP_invocation_identifier`.
* @public
* @readonly
*/
readonly called_AP_invocation_identifier: OPTIONAL<AP_invocation_identifier>;
/**
* @summary `called_AE_invocation_identifier`.
* @public
* @readonly
*/
readonly called_AE_invocation_identifier: OPTIONAL<AE_invocation_identifier>;
/**
* @summary `calling_AP_title`.
* @public
* @readonly
*/
readonly calling_AP_title: OPTIONAL<AP_title>;
/**
* @summary `calling_AE_qualifier`.
* @public
* @readonly
*/
readonly calling_AE_qualifier: OPTIONAL<AE_qualifier>;
/**
* @summary `calling_AP_invocation_identifier`.
* @public
* @readonly
*/
readonly calling_AP_invocation_identifier: OPTIONAL<AP_invocation_identifier>;
/**
* @summary `calling_AE_invocation_identifier`.
* @public
* @readonly
*/
readonly calling_AE_invocation_identifier: OPTIONAL<AE_invocation_identifier>;
/**
* @summary `sender_acse_requirements`.
* @public
* @readonly
*/
readonly sender_acse_requirements: OPTIONAL<ACSE_requirements>;
/**
* @summary `mechanism_name`.
* @public
* @readonly
*/
readonly mechanism_name: OPTIONAL<Mechanism_name>;
/**
* @summary `calling_authentication_value`.
* @public
* @readonly
*/
readonly calling_authentication_value: OPTIONAL<Authentication_value>;
/**
* @summary `aSO_context_name_list`.
* @public
* @readonly
*/
readonly aSO_context_name_list: OPTIONAL<ASO_context_name_list>;
/**
* @summary `implementation_information`.
* @public
* @readonly
*/
readonly implementation_information: OPTIONAL<Implementation_data>;
/**
* @summary `p_context_definition_list`.
* @public
* @readonly
*/
readonly p_context_definition_list: OPTIONAL<Syntactic_context_list>;
/**
* @summary `called_asoi_tag`.
* @public
* @readonly
*/
readonly called_asoi_tag: OPTIONAL<ASOI_tag>;
/**
* @summary `calling_asoi_tag`.
* @public
* @readonly
*/
readonly calling_asoi_tag: OPTIONAL<ASOI_tag>;
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
readonly _unrecognizedExtensionsList: _Element[];
/**
* @summary `user_information`.
* @public
* @readonly
*/
readonly user_information: OPTIONAL<Association_data>;
constructor(
/**
* @summary `protocol_version`.
* @public
* @readonly
*/
protocol_version: OPTIONAL<AARQ_apdu_protocol_version>,
/**
* @summary `aSO_context_name`.
* @public
* @readonly
*/
aSO_context_name: ASO_context_name,
/**
* @summary `called_AP_title`.
* @public
* @readonly
*/
called_AP_title: OPTIONAL<AP_title>,
/**
* @summary `called_AE_qualifier`.
* @public
* @readonly
*/
called_AE_qualifier: OPTIONAL<AE_qualifier>,
/**
* @summary `called_AP_invocation_identifier`.
* @public
* @readonly
*/
called_AP_invocation_identifier: OPTIONAL<AP_invocation_identifier>,
/**
* @summary `called_AE_invocation_identifier`.
* @public
* @readonly
*/
called_AE_invocation_identifier: OPTIONAL<AE_invocation_identifier>,
/**
* @summary `calling_AP_title`.
* @public
* @readonly
*/
calling_AP_title: OPTIONAL<AP_title>,
/**
* @summary `calling_AE_qualifier`.
* @public
* @readonly
*/
calling_AE_qualifier: OPTIONAL<AE_qualifier>,
/**
* @summary `calling_AP_invocation_identifier`.
* @public
* @readonly
*/
calling_AP_invocation_identifier: OPTIONAL<AP_invocation_identifier>,
/**
* @summary `calling_AE_invocation_identifier`.
* @public
* @readonly
*/
calling_AE_invocation_identifier: OPTIONAL<AE_invocation_identifier>,
/**
* @summary `sender_acse_requirements`.
* @public
* @readonly
*/
sender_acse_requirements: OPTIONAL<ACSE_requirements>,
/**
* @summary `mechanism_name`.
* @public
* @readonly
*/
mechanism_name: OPTIONAL<Mechanism_name>,
/**
* @summary `calling_authentication_value`.
* @public
* @readonly
*/
calling_authentication_value: OPTIONAL<Authentication_value>,
/**
* @summary `aSO_context_name_list`.
* @public
* @readonly
*/
aSO_context_name_list: OPTIONAL<ASO_context_name_list>,
/**
* @summary `implementation_information`.
* @public
* @readonly
*/
implementation_information: OPTIONAL<Implementation_data>,
/**
* @summary `p_context_definition_list`.
* @public
* @readonly
*/
p_context_definition_list: OPTIONAL<Syntactic_context_list>,
/**
* @summary `called_asoi_tag`.
* @public
* @readonly
*/
called_asoi_tag: OPTIONAL<ASOI_tag>,
/**
* @summary `calling_asoi_tag`.
* @public
* @readonly
*/
calling_asoi_tag: OPTIONAL<ASOI_tag>,
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
_unrecognizedExtensionsList: _Element[],
/**
* @summary `user_information`.
* @public
* @readonly
*/
user_information: OPTIONAL<Association_data>);
/**
* @summary Restructures an object into a AARQ_apdu
* @description
*
* This takes an `object` and converts it to a `AARQ_apdu`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `AARQ_apdu`.
* @returns {AARQ_apdu}
*/
static _from_object(_o: {
[_K in keyof AARQ_apdu]: AARQ_apdu[_K];
}): AARQ_apdu;
/**
* @summary Getter that returns the default value for `protocol_version`.
* @public
* @static
* @method
*/
static get _default_value_for_protocol_version(): AARQ_apdu_protocol_version;
}
/**
* @summary The Leading Root Component Types of AARQ_apdu
* @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_AARQ_apdu: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of AARQ_apdu
* @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_AARQ_apdu: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of AARQ_apdu
* @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_AARQ_apdu: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) AARQ_apdu
* @function
* @param {_Element} el The element being decoded.
* @returns {AARQ_apdu} The decoded data structure.
*/
export declare function _decode_AARQ_apdu(el: _Element): AARQ_apdu;
/**
* @summary Encodes a(n) AARQ_apdu 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 AARQ_apdu, encoded as an ASN.1 Element.
*/
export declare function _encode_AARQ_apdu(value: AARQ_apdu, elGetter: $.ASN1Encoder<AARQ_apdu>): _Element;
//# sourceMappingURL=AARQ-apdu.ta.d.mts.map