@wildboar/acse
Version:
Association Control Service Element PDUs in TypeScript
344 lines • 11 kB
text/typescript
import { OPTIONAL, ASN1Element as _Element } from '@wildboar/asn1';
import * as $ from '@wildboar/asn1/functional';
import { AARE_apdu_protocol_version } from '../ACSE-1/AARE-apdu-protocol-version.ta.mjs';
import { ASO_context_name } from '../ACSE-1/ASO-context-name.ta.mjs';
import { Associate_result } from '../ACSE-1/Associate-result.ta.mjs';
import { Associate_source_diagnostic } from '../ACSE-1/Associate-source-diagnostic.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 { P_context_result_list } from '../ACSE-1/P-context-result-list.ta.mjs';
import { ASOI_tag } from '../ACSE-1/ASOI-tag.ta.mjs';
/**
* @summary AARE_apdu
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* AARE-apdu ::= [APPLICATION 1] IMPLICIT SEQUENCE {
* protocol-version
* [0] IMPLICIT BIT STRING {version1(0)} DEFAULT {version1},
* aSO-context-name [1] ASO-context-name,
* result [2] Associate-result,
* result-source-diagnostic [3] Associate-source-diagnostic,
* responding-AP-title [4] AP-title OPTIONAL,
* responding-AE-qualifier [5] AE-qualifier OPTIONAL,
* responding-AP-invocation-identifier [6] AP-invocation-identifier OPTIONAL,
* responding-AE-invocation-identifier [7] AE-invocation-identifier OPTIONAL,
* -- The following field shall not be present if only the Kernel is used.
* responder-acse-requirements [8] IMPLICIT ACSE-requirements OPTIONAL,
* -- The following field shall only be present if the Authentication functional unit is selected.
* mechanism-name [9] IMPLICIT Mechanism-name OPTIONAL,
* -- This following field shall only be present if the Authentication functional unit is selected.
* responding-authentication-value
* [10] EXPLICIT Authentication-value OPTIONAL,
* aSO-context-name-list
* [11] 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-result-list
* [12] IMPLICIT P-context-result-list OPTIONAL,
* called-asoi-tag [13] IMPLICIT ASOI-tag OPTIONAL,
* calling-asoi-tag [14] IMPLICIT ASOI-tag OPTIONAL,
* -- End of extensions for higher level association FU
* ...,
* user-information [30] IMPLICIT Association-data OPTIONAL
* }
* ```
*
*/
export declare class AARE_apdu {
/**
* @summary `protocol_version`.
* @public
* @readonly
*/
readonly protocol_version: OPTIONAL<AARE_apdu_protocol_version>;
/**
* @summary `aSO_context_name`.
* @public
* @readonly
*/
readonly aSO_context_name: ASO_context_name;
/**
* @summary `result`.
* @public
* @readonly
*/
readonly result: Associate_result;
/**
* @summary `result_source_diagnostic`.
* @public
* @readonly
*/
readonly result_source_diagnostic: Associate_source_diagnostic;
/**
* @summary `responding_AP_title`.
* @public
* @readonly
*/
readonly responding_AP_title?: OPTIONAL<AP_title>;
/**
* @summary `responding_AE_qualifier`.
* @public
* @readonly
*/
readonly responding_AE_qualifier?: OPTIONAL<AE_qualifier>;
/**
* @summary `responding_AP_invocation_identifier`.
* @public
* @readonly
*/
readonly responding_AP_invocation_identifier?: OPTIONAL<AP_invocation_identifier>;
/**
* @summary `responding_AE_invocation_identifier`.
* @public
* @readonly
*/
readonly responding_AE_invocation_identifier?: OPTIONAL<AE_invocation_identifier>;
/**
* @summary `responder_acse_requirements`.
* @public
* @readonly
*/
readonly responder_acse_requirements?: OPTIONAL<ACSE_requirements>;
/**
* @summary `mechanism_name`.
* @public
* @readonly
*/
readonly mechanism_name?: OPTIONAL<Mechanism_name>;
/**
* @summary `responding_authentication_value`.
* @public
* @readonly
*/
readonly responding_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_result_list`.
* @public
* @readonly
*/
readonly p_context_result_list?: OPTIONAL<P_context_result_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<AARE_apdu_protocol_version>,
/**
* @summary `aSO_context_name`.
* @public
* @readonly
*/
aSO_context_name: ASO_context_name,
/**
* @summary `result`.
* @public
* @readonly
*/
result: Associate_result,
/**
* @summary `result_source_diagnostic`.
* @public
* @readonly
*/
result_source_diagnostic: Associate_source_diagnostic,
/**
* @summary `responding_AP_title`.
* @public
* @readonly
*/
responding_AP_title?: OPTIONAL<AP_title>,
/**
* @summary `responding_AE_qualifier`.
* @public
* @readonly
*/
responding_AE_qualifier?: OPTIONAL<AE_qualifier>,
/**
* @summary `responding_AP_invocation_identifier`.
* @public
* @readonly
*/
responding_AP_invocation_identifier?: OPTIONAL<AP_invocation_identifier>,
/**
* @summary `responding_AE_invocation_identifier`.
* @public
* @readonly
*/
responding_AE_invocation_identifier?: OPTIONAL<AE_invocation_identifier>,
/**
* @summary `responder_acse_requirements`.
* @public
* @readonly
*/
responder_acse_requirements?: OPTIONAL<ACSE_requirements>,
/**
* @summary `mechanism_name`.
* @public
* @readonly
*/
mechanism_name?: OPTIONAL<Mechanism_name>,
/**
* @summary `responding_authentication_value`.
* @public
* @readonly
*/
responding_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_result_list`.
* @public
* @readonly
*/
p_context_result_list?: OPTIONAL<P_context_result_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 AARE_apdu
* @description
*
* This takes an `object` and converts it to a `AARE_apdu`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `AARE_apdu`.
* @returns {AARE_apdu}
*/
static _from_object(_o: {
[_K in keyof AARE_apdu]: AARE_apdu[_K];
}): AARE_apdu;
/**
* @summary Getter that returns the default value for `protocol_version`.
* @public
* @static
* @method
*/
static get _default_value_for_protocol_version(): AARE_apdu_protocol_version;
}
/**
* @summary The Leading Root Component Types of AARE_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_AARE_apdu: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of AARE_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_AARE_apdu: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of AARE_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_AARE_apdu: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) AARE_apdu
* @function
* @param {_Element} el The element being decoded.
* @returns {AARE_apdu} The decoded data structure.
*/
export declare function _decode_AARE_apdu(el: _Element): AARE_apdu;
/**
* @summary Encodes a(n) AARE_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 AARE_apdu, encoded as an ASN.1 Element.
*/
export declare function _encode_AARE_apdu(value: AARE_apdu, elGetter: $.ASN1Encoder<AARE_apdu>): _Element;
//# sourceMappingURL=AARE-apdu.ta.d.mts.map