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: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public class Instance : IInstance, IBitSize

The Instance type exposes the following members.

Properties

 

Name

Description

Instance Class 1:

Attributes

Gets the Type Attributes.

Instance Class 2:

BitSize

Gets the size of this Instance in bits.

Instance Class 3:

ByteSize

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

Instance Class 4:

Category

Gets the the DataTypeCategory of the Instance.

Instance Class 5:

Comment

Gets the comment.

Instance Class 6:

ContextMask

Gets the context mask of this instance.

Instance Class 7:

DataType

Gets the IDataType of the IInstance.

Instance Class 8:

HasValue

Gets a value indicating whether this instance has a value.

Instance Class 9:

InstanceName

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

Instance Class 10:

InstancePath

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

Instance Class 11:

IsBitType

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

Instance Class 12:

IsByteAligned

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

Instance Class 13:

IsPersistent

Indicates that this instance is persistent.

Instance Class 14:

IsPointer

Gets a value indicating whether this instance is reference.

Instance Class 15:

IsProperty

Gets a value indicating whether IInstance is a property.

Instance Class 16:

IsReadOnly

Indicates that this instance is read only.

Instance Class 17:

IsReference

Gets a value indicating whether this instance is reference.

Instance Class 18:

IsStatic

Gets a value indicating whether this IInstance is static.

Instance Class 19:

IsTcComInterfacePointer

Indicates that this instance is a TcComInterfacePointer.

Instance Class 20:

IsTypeGuid

Indicates that this instance has set TypeGuid flag.

Instance Class 21:

Namespace

Gets the namespace name.

Instance Class 22:

Size

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

Instance Class 23:

TypeName

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

Methods

 

Name

Description

Instance Class 24:

Instance Class 25:

AlignTypeName

Aligns the type name

Instance Class 26:

Equals

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

Instance Class 27:

Finalize

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

Instance Class 28:

GetHashCode

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

Instance Class 29:

GetType

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

Instance Class 30:

MemberwiseClone

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

Instance Class 31:

OnGetSize

Handler function getting the size of the Instance

Instance Class 32:

OnSetInstanceName

Sets a new InstanceName InstancePath

Instance Class 33:

SetAttributes

Sets the type attributes

Instance Class 34:

SetContextMask

Sets the context mask.

Instance Class 35:

ToString

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

Extension Methods

 

Name

Description

HasExternalDataReferences

Indicates, that the Instance value includes process memory data, that cannot be read in one memory block.
(Defined by DataTypeExtension)

IsExternalDataReference

Indicates, that the field is static or is not part of the parents processimage memory location
(Defined by DataTypeExtension)

See Also

Reference

TwinCAT.Ads.TypeSystem Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026

Further Information
See also