Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Key

An interface for the keys composing the property [[AASReferenceType.keys]] of an AAS Reference.

Hierarchy

  • BaseUAObject
    • Key

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Key(): Key

  • Returns Key

Properties

idType

idType: IdentifierType

The kind of Key.

local

local: boolean

A flag specifying whether the entity referred by this Key is local to the current AAS or not.

schema

schema: StructuredTypeSchema

type

type: KeyElements

The kind of entity referred by this Key.

value

value: string

The identifier of the entity referred by this key.

Methods

binaryStoreSize

  • binaryStoreSize(): number

  • Calculate the required size to store this object in a binary stream.

    method

    binaryStoreSize

    Returns number

    number

clone

  • clone(): any

  • Returns any

decode

  • decode(stream: BinaryStream): void

  • Decode the object from the binary stream.

    class

    BaseUAObject

    method

    decode

    Parameters

    • stream: BinaryStream

    Returns void

decodeDebug

  • decodeDebug(stream: BinaryStream, options: DecodeDebugOptions): void
  • method

    decodeDebug

    Parameters

    • stream: BinaryStream
    • options: DecodeDebugOptions

    Returns void

encode

  • encode(stream: OutputBinaryStream): void

  • Encode the object to the binary stream.

    class

    BaseUAObject

    method

    encode

    Parameters

    • stream: OutputBinaryStream

    Returns void

explore

  • explore(): string

  • Returns string

isValid

  • isValid(): boolean

  • verify that all object attributes values are valid according to schema

    method

    isValid

    Returns boolean

    boolean

toJSON

  • toJSON(): any

  • Returns any

toString

  • toString(...args: any[]): string
  • method

    toString

    Parameters

    • Rest ...args: any[]

    Returns string

Generated using TypeDoc