ITcAdsSubItem Interface

Interface ITcAdsSubItem

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public interface ITcAdsSubItem : ITcAdsDataType, 
    IDataType, IBitSize

VB

Public Interface ITcAdsSubItem
    Inherits ITcAdsDataType, IDataType, IBitSize

The ITcAdsSubItem type exposes the following members.

Properties

 

Name

Description

Attributes

Gets the attributes of the IDataType (Inherited from IDataType.)

BaseType

Gets the Base Type of the Type (if enum, alias, array) (Inherited from ITcAdsDataType.)

BaseTypeName

Gets the name of the base type (if enum, alias, array) (Inherited from ITcAdsDataType.)

BitSize

Gets the size of the IDataType in bits. (Inherited from IBitSize.)

ByteSize

Gets the (aligned) size of of the Type/Instance in Bytes (Inherited from IBitSize.)

Category

Gets the Data Type category (Inherited from IDataType.)

Comment

Gets the comment behind the variable declaration. (Inherited from IDataType.)

DataTypeId

Gets the data type identifier. (Inherited from ITcAdsDataType.)

Dimensions

Gets the dimensions of an array type (Inherited from ITcAdsDataType.)

EnumValues

Enumeration specification (if enum) (Inherited from ITcAdsDataType.)

FullName

Gets the full name of the IDataType (Namespace + Name) (Inherited from IDataType.)

HasArrayInfo

Gets a value indicating whether this instance has dimension information. (Inherited from ITcAdsDataType.)

HasEnumInfo

Gets a value indicating whether this instance has enum information. (Inherited from ITcAdsDataType.)

HasRpcMethods

Gets a value indicating whether this instance has RPC methods (Struct types only) (Inherited from ITcAdsDataType.)

HasSubItemInfo

Gets a value indicating whether this instance has sub items. (Inherited from ITcAdsDataType.)

Id

Gets the ID of the DataType (Inherited from IDataType.)

IsBitType

Gets a value indicating whether this instance is not basing on a full DataType but instead of some sort of bit mapping (Inherited from IBitSize.)

IsByteAligned

Indicates that the Size of the Object is Byte aligned (BitSize % 8 == 0) (Inherited from IBitSize.)

IsContainer

Gets a value indicating whether this IDataType is a container type (Inherited from IDataType.)

IsJaggedArray

Gets a value indicating whether this dataType is a jagged array. (Inherited from ITcAdsDataType.)

IsOversamplingArray

Gets a value indicating whether this instance is an oversampling array. (Inherited from ITcAdsDataType.)

IsPersistent

Gets a value indicating whether this sub element is persistent.

IsPointer

Gets a value indicating whether this IDataType is a pointer type (Inherited from IDataType.)

IsPrimitive

Gets a value indicating whether this IDataType is primitive (Inherited from IDataType.)

IsReference

Gets a value indicating whether this IDataType is a reference type (Inherited from IDataType.)

IsSubItem

Determines whether this object is an SubItem (DataType Member, true) or a native DataType (false) (Inherited from ITcAdsDataType.)

ManagedType

Managed Type of the (simple,primitive) type. (Inherited from ITcAdsDataType.)

Name

Gets the name of the Data Type (without namespace) (Inherited from IDataType.)

Namespace

Gets the namespace string within the IDataType exists. (Inherited from IDataType.)

Offset

Gets the offset of the SubItem (in Bytes or Bits)

RpcMethods

Gets the RPC method descriptions (Inherited from ITcAdsDataType.)

Size

Gets the size of the object in bytes or Bits dependant on IsBitType (Inherited from IBitSize.)

SubItemName

Gets the name of the subitem / Sub element.

SubItems

Get the SubElements of this ITcAdsDataType. (Inherited from ITcAdsDataType.)

Reference

TwinCAT.Ads Namespace