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

Attributes

Gets the Type Attributes. (Inherited from Instance.)

BitSize

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

ByteSize

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

Category

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

Comment

Gets the comment. (Inherited from Instance.)

ContextMask

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

DataType

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

HasValue

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

InstanceName

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

InstancePath

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

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.)

IsByteAligned

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

IsPersistent

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

IsPointer

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

IsReadOnly

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

IsReference

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

IsStatic

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

IsTcComInterfacePointer

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

IsTypeGuid

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

Namespace

Gets the namespace name. (Inherited from Instance.)

ParentType

Gets the Parent of this IField.

Size

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

TypeName

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

Methods

 

Name

Description

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

OnSetInstanceName

Sets a new InstanceName InstancePath (Inherited from Instance.)

SetContextMask

Sets the context mask. (Inherited from Instance.)

ToString

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

Fields

 

Name

Description

attributes

The attributes (Inherited from Instance.)

Reference

TwinCAT.Ads.TypeSystem Namespace