Instance Class

Instance implementation

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.TypeSystem.Instance
    TwinCAT.Ads.TypeSystem.Field
    TwinCAT.Ads.TypeSystem.Symbol
Namespace:  TwinCAT.Ads.TypeSystem
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public class Instance : IInstance, IBitSize

VB

Public Class Instance
    Implements IInstance, IBitSize

The Instance type exposes the following members.

Properties

 

Name

Description

Attributes

Gets the Type Attributes.

BitSize

Gets the size of this Instance in bits.

ByteSize

Gets the (aligned) size of of the Type/Instance in Bytes

Category

Gets the the DataTypeCategory of the Instance.

Comment

Gets the comment.

ContextMask

Gets the context mask of this instance.

DataType

Gets the IDataType of the IInstance.

HasValue

Gets a value indicating whether this instance has a value.

InstanceName

Gets the name of the instance (without periods (.)

InstancePath

Gets the relative / absolute access path to the instance (with periods (.))

IsBitType

Gets a value indicating whether this instance is not basing on a full DataType but instead of some sort of bit mapping

IsByteAligned

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

IsPersistent

Indicates if this instance is persistent.

IsPointer

Gets a value indicating whether this instance is reference.

IsReadOnly

Indicates if this instance is read only.

IsReference

Gets a value indicating whether this instance is reference.

IsStatic

Gets a value indicating whether this IInstance is static.

IsTcComInterfacePointer

Indicates if this instance is a TcComInterfacePointer.

IsTypeGuid

Indicates if this instance has set TypeGuid flag.

Namespace

Gets the namespace name.

Size

Gets the size of the IDataType in bytes or Bits dependant on IsBitType

TypeName

Gets the name of the DataType that is used for this IInstance.

Methods

 

Name

Description

AlignTypeName

Aligns the type name

Equals

Determines whether the specified object is equal to the current object. (Inherited from Object.)

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

GetHashCode

Serves as the default hash function. (Inherited from Object.)

GetType

Gets the Type of the current instance. (Inherited from Object.)

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

OnGetSize

Handler function getting the size of the Instance

OnSetInstanceName

Sets a new InstanceName InstancePath

SetContextMask

Sets the context mask.

ToString

Returns a String that represents this instance. (Overrides Object.ToString..)

Fields

 

Name

Description

attributes

The attributes

Reference

TwinCAT.Ads.TypeSystem Namespace