Field Class

Represents a field of an Struct/Alias/Union

Inheritance Hierarchy

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

Syntax

C#

public class Field : Instance, IField, 
    IAttributedInstance, IInstance, IBitSize

VB

Public Class Field
    Inherits Instance
    Implements IField, IAttributedInstance, IInstance, IBitSize

The Field type exposes the following members.

Properties

 

Name

Description

Field Class 1:

Attributes

Gets the Type Attributes. (Inherited from Instance.)

Field Class 2:

BitSize

Gets the size of this Instance in bits. (Inherited from Instance.)

Field Class 3:

ByteSize

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

Field Class 4:

Category

Gets the the DataTypeCategory of the Instance. (Inherited from Instance.)

Field Class 5:

Comment

Gets the comment. (Inherited from Instance.)

Field Class 6:

ContextMask

Gets the context mask of this instance. (Inherited from Instance.)

Field Class 7:

DataType

Gets the IDataType of the IInstance. (Inherited from Instance.)

Field Class 8:

HasValue

Gets a value indicating whether this instance has a value. (Inherited from Instance.)

Field Class 9:

InstanceName

Gets the name of the instance (without periods (.) (Inherited from Instance.)

Field Class 10:

InstancePath

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

Field 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 (Inherited from Instance.)

Field Class 12:

IsByteAligned

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

Field Class 13:

IsPersistent

Indicates if this instance is persistent. (Inherited from Instance.)

Field Class 14:

IsPointer

Gets a value indicating whether this instance is reference. (Inherited from Instance.)

Field Class 15:

IsReadOnly

Indicates if this instance is read only. (Inherited from Instance.)

Field Class 16:

IsReference

Gets a value indicating whether this instance is reference. (Inherited from Instance.)

Field Class 17:

IsStatic

Gets a value indicating whether this IInstance is static. (Inherited from Instance.)

Field Class 18:

IsTcComInterfacePointer

Indicates if this instance is a TcComInterfacePointer. (Inherited from Instance.)

Field Class 19:

IsTypeGuid

Indicates if this instance has set TypeGuid flag. (Inherited from Instance.)

Field Class 20:

Namespace

Gets the namespace name. (Inherited from Instance.)

Field Class 21:

ParentType

Gets the Parent of this IField.

Field Class 22:

Size

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

Field Class 23:

TypeName

Gets the name of the DataType that is used for this IInstance. (Inherited from Instance.)

Methods

 

Name

Description

Field Class 24:

Equals

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

Field Class 25:

Finalize

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

Field Class 26:

GetHashCode

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

Field Class 27:

GetType

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

Field Class 28:

MemberwiseClone

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

Field Class 29:

OnGetSize

Handler function getting the size of the Instance (Inherited from Instance.)

Field Class 30:

OnSetInstanceName

Sets a new InstanceName InstancePath (Inherited from Instance.)

Field Class 31:

SetContextMask

Sets the context mask. (Inherited from Instance.)

Field Class 32:

ToString

Returns a String that represents this instance. (Inherited from Instance.)

Fields

 

Name

Description

Field Class 33:

attributes

The attributes (Inherited from Instance.)

Reference

TwinCAT.Ads.TypeSystem Namespace