ADS data type object

interface AdsDataType {
    adsDataType: number;
    adsDataTypeStr: string;
    arrayDimension: number;
    arrayInfos: AdsArrayInfoEntry[];
    attributes: AdsAttributeEntry[];
    comment: string;
    enumInfos: AdsEnumInfoEntry[];
    extendedFlags: number;
    flags: number;
    flagsStr: string[];
    hashValue: number;
    name: string;
    offset: number;
    reserved: Buffer;
    rpcMethods: AdsRpcMethodEntry[];
    size: number;
    subItems: AdsDataType[];
    type: string;
    typeGuid: string;
    typeHashValue: number;
    version: number;
}

Properties

adsDataType: number

ADS data type as number (see ADS.ADS_DATA_TYPES)

adsDataTypeStr: string

ADS data type as string (see ADS.ADS_DATA_TYPES)

arrayDimension: number

Array dimension (if array)

arrayInfos: AdsArrayInfoEntry[]

If data type is an array, information of each array dimension

attributes: AdsAttributeEntry[]

Attributes

comment: string

Data type comment (comment in the PLC code)

enumInfos: AdsEnumInfoEntry[]

Enumeration info

extendedFlags: number

Data type extended flags

flags: number

Data type flags as bit-notation (see ADS.ADS_DATA_TYPE_FLAGS)

flagsStr: string[]

Data type flags as string array (see ADS.ADS_DATA_TYPE_FLAGS)

hashValue: number

Hash value of data type (for comparison)

name: string

Name of this entry

IMPORTANT NOTE:

  • If entry is a subitem (e.g. struct member, item: WORD), this is the variable name (item)
  • If entry is not a subitem / it's the topmost type, this is the data type name (WORD)

See also type

offset: number

Offset of the entry in parent data type (bytes or bits if BitValues flag)

reserved: Buffer

Reserved data

rpcMethods: AdsRpcMethodEntry[]

RPC methods

size: number

Data type size (bytes or bits if BitValues flag)

subItems: AdsDataType[]

Subitems (children data types) of this data type (e.g. struct members)

type: string

Type of this entry

IMPORTANT NOTE:

  • If entry is a subitem (e.g. struct member, item: WORD), this is the variable type (WORD)
  • If entry is not a subitem / it's the topmost type, this is empty string (``)

See also name

typeGuid: string

Data type unique identifier (GUID)

typeHashValue: number

Type hash value

version: number

Structure version