Class AdministrativeInformation

Administrative meta-information for an element like version information.

Constraint AASd-005: If version is not specified then also revision shall be unspecified. This means, a revision requires a version. If there is no version there is no revision neither. Revision is optional.

Hierarchy

Class
- AdministrativeInformation

Implements

IHasDataSpecification

Index

Constructors

constructor

new AdministrativeInformation(embeddedDataSpecifications?: EmbeddedDataSpecification[], version?: string, revision?: string, creator?: Reference, templateId?: string): AdministrativeInformation
Parameters
- embeddedDataSpecifications: EmbeddedDataSpecification[] = null
- version: string = null
- revision: string = null
- creator: Reference = null
- templateId: string = null
Returns AdministrativeInformation
Overrides Class.constructor
- Defined in types.ts:833

Properties

creator

creator: Reference

The subject ID of the subject responsible for making the element.

embeddedDataSpecifications

embeddedDataSpecifications: EmbeddedDataSpecification[]

Embedded data specification.

revision

revision: string

Revision of the element.

templateId

templateId: string

Identifier of the template that guided the creation of the element.

Remarks

Note: In case of a submodel the templateId is the identifier of the submodel template ID that guided the creation of the submodel

Note: The templateId is not relevant for validation in Submodels. For validation the semanticId shall be used.

Note: Usage of templateId is not restricted to submodel instances. So also the creation of submodel templates can be guided by another submodel template.

version

version: string

Version of the element.

Methods

accept

accept(visitor: AbstractVisitor): void
Dispatch visitor on this instance.
Parameters
- visitor: AbstractVisitor
  
  to visit this instance
Returns void
Implementation of IHasDataSpecification.accept

Overrides Class.accept
- Defined in types.ts:788

acceptWithContext

acceptWithContext<ContextT>(visitor: AbstractVisitorWithContext<ContextT>, context: ContextT): void
Dispatch visitor with context on this instance.
Type Parameters
- ContextT
  
  type of the context
Parameters
- visitor: AbstractVisitorWithContext<ContextT>
  
  to visit this instance
- context: ContextT
  
  to be passed along to the dispatched visitor method
Returns void
Implementation of IHasDataSpecification.acceptWithContext

Overrides Class.acceptWithContext
- Defined in types.ts:799

descend

descend(): IterableIterator<Class>
Iterate recursively over the instances referenced from this instance.

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Implementation of IHasDataSpecification.descend

Overrides Class.descend
- Defined in types.ts:767

descendOnce

descendOnce(): IterableIterator<Class>
Iterate over the instances referenced from this instance.

We do not recurse into the referenced instances.

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Implementation of IHasDataSpecification.descendOnce

Overrides Class.descendOnce
- Defined in types.ts:752

modelType

modelType(): ModelType
Indicate the runtime model type of the instance.

Returns ModelType
Implementation of IHasDataSpecification.modelType

Overrides Class.modelType
- Defined in types.ts:690

overEmbeddedDataSpecificationsOrEmpty

overEmbeddedDataSpecificationsOrEmpty(): IterableIterator<EmbeddedDataSpecification>
Yield from embeddedDataSpecifications if it is set, or yield nothing.

Returns IterableIterator<EmbeddedDataSpecification>
Implementation of IHasDataSpecification.overEmbeddedDataSpecificationsOrEmpty
- Defined in types.ts:738

transform

transform<T>(transformer: AbstractTransformer<T>): T
Dispatch the transformer on this instance.

Returns
transformation of this instance

Param Type
T - type of the transformation result
Type Parameters
- T
Parameters
- transformer: AbstractTransformer<T>
  
  to transform this instance
Returns T
Implementation of IHasDataSpecification.transform

Overrides Class.transform
- Defined in types.ts:813

transformWithContext

transformWithContext<ContextT, T>(transformer: AbstractTransformerWithContext<ContextT, T>, context: ContextT): T
Dispatch the transformer on this instance in context.

Returns
transformation of this instance

Param Type
T - type of the transformation result

Param Type
ContextT - type of the transformation context
Type Parameters
- ContextT
- T
Parameters
- transformer: AbstractTransformerWithContext<ContextT, T>
  
  to transform this instance
- context: ContextT
  
  to be passed along to the transformer
Returns T
Implementation of IHasDataSpecification.transformWithContext

Overrides Class.transformWithContext
- Defined in types.ts:826

Class AdministrativeInformation

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

embeddedDataSpecifications: EmbeddedDataSpecification[] = null

version: string = null

revision: string = null

creator: Reference = null

templateId: string = null

Returns AdministrativeInformation

Properties

creator

embeddedDataSpecifications

revision

templateId

Remarks

version

Methods

accept

Parameters

visitor: AbstractVisitor

Returns void

acceptWithContext

Type Parameters

ContextT

Parameters

visitor: AbstractVisitorWithContext<ContextT>

context: ContextT

Returns void

descend

Returns

Returns IterableIterator<Class>

descendOnce

Returns

Returns IterableIterator<Class>

modelType

Returns ModelType

overEmbeddedDataSpecificationsOrEmpty

Returns IterableIterator<EmbeddedDataSpecification>

transform

Returns

Param Type

Type Parameters

T

Parameters

transformer: AbstractTransformer<T>

Returns T

transformWithContext

Returns

Param Type

Param Type

Type Parameters

ContextT

T

Parameters

transformer: AbstractTransformerWithContext<ContextT, T>

context: ContextT

Returns T

Settings

Member Visibility

Theme