UnionInstance Class

Class representing a Union Instance

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.TypeSystem.Instance
    TwinCAT.Ads.TypeSystem.Symbol
      TwinCAT.Ads.TypeSystem.UnionInstance
Namespace:  TwinCAT.Ads.TypeSystem
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.116+a71ced3

Syntax

C#

public sealed class UnionInstance : Symbol, 
    IUnionInstance, ISymbol, IAttributedInstance, IInstance, IBitSize

The UnionInstance type exposes the following members.

Properties

 

Name

Description

UnionInstance Class 1:

AccessRights

Gets the access rights. (Inherited from Symbol.)

UnionInstance Class 2:

Attributes

Gets the Type Attributes. (Inherited from Instance.)

UnionInstance Class 3:

BitSize

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

UnionInstance Class 4:

ByteSize

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

UnionInstance Class 5:

Category

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

UnionInstance Class 6:

Comment

Gets the comment. (Inherited from Instance.)

UnionInstance Class 7:

Connection

Gets the connection that produces values for this IValueSymbol (Inherited from Symbol.)

UnionInstance Class 8:

ContextMask

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

UnionInstance Class 9:

DataType

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

UnionInstance Class 10:

FieldInstances

Gets the member instances of the Struct Instance.

UnionInstance Class 11:

HasValue

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

UnionInstance Class 12:

ImageBaseAddress

Gets the AmsAddress of the Process Image (Inherited from Symbol.)

UnionInstance Class 13:

IndexGroup

Gets the index group of the Symbol (Inherited from Symbol.)

UnionInstance Class 14:

IndexOffset

Gets the index offset of the Symbol (Inherited from Symbol.)

UnionInstance Class 15:

InstanceName

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

UnionInstance Class 16:

InstancePath

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

UnionInstance Class 17:

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

UnionInstance Class 18:

IsByteAligned

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

UnionInstance Class 19:

IsContainerType

Gets a value indicating whether this Symbol is a container/complex type. (Overrides Symbol.IsContainerType.)

UnionInstance Class 20:

IsDereferencedPointer

Gets or sets a value indicating whether an ancestor is a dereferenced Pointer (Inherited from Symbol.)

UnionInstance Class 21:

IsDereferencedReference

Gets or sets a value indicating whether an ancestor is a dereferenced Reference (Inherited from Symbol.)

UnionInstance Class 22:

IsPersistent

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

UnionInstance Class 23:

IsPointer

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

UnionInstance Class 24:

IsPrimitiveType

Gets a value indicating whether this instance is primitive. (Overrides Symbol.IsPrimitiveType.)

UnionInstance Class 25:

IsReadOnly

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

UnionInstance Class 26:

IsRecursive

Gets a value indicating whether this instance is recursive. (Inherited from Symbol.)

UnionInstance Class 27:

IsReference

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

UnionInstance Class 28:

IsStatic

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

UnionInstance Class 29:

IsTcComInterfacePointer

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

UnionInstance Class 30:

IsTypeGuid

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

UnionInstance Class 31:

IsVirtual

Gets a value indicating whether this instance is virtual. (Inherited from Symbol.)

UnionInstance Class 32:

Namespace

Gets the namespace name. (Inherited from Instance.)

UnionInstance Class 33:

NotificationSettings

Gets or sets the notification settings. (Inherited from Symbol.)

UnionInstance Class 34:

Parent

Gets the parent Symbol (Inherited from Symbol.)

UnionInstance Class 35:

Size

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

UnionInstance Class 36:

SubSymbolCount

Gets the number of SubSymbols (Inherited from Symbol.)

UnionInstance Class 37:

SubSymbols

Gets the SubSymbols of the ISymbol (Inherited from Symbol.)

UnionInstance Class 38:

TypeName

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

UnionInstance Class 39:

ValueEncoding

Gets the value encoding. (Inherited from Symbol.)

Methods

 

Name

Description

UnionInstance Class 40:

Equals

Equals (Inherited from Symbol.)

UnionInstance Class 41:

GetHashCode

Gets the HashCode of the Address (Inherited from Symbol.)

UnionInstance Class 42:

GetType

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

UnionInstance Class 43:

ReadAnyValue(Type)

Reads the value of this Value into a new created instance of the managed type (Inherited from Symbol.)

UnionInstance Class 44:

ReadAnyValue(Type, Int32)

Reads the value of this Value into a new created instance of the managed type (Inherited from Symbol.)

UnionInstance Class 45:

ReadAnyValueAsync

Reads the (AnyType) value asynchronously. (Inherited from Symbol.)

UnionInstance Class 46:

ReadRawValue.

Reads the raw value of the IValueSymbol (Ads Read / Write) (Inherited from Symbol.)

UnionInstance Class 47:

ReadRawValue(Int32)

Reads the raw value of the IValueSymbol (Ads Read / Write) (Inherited from Symbol.)

UnionInstance Class 48:

ReadRawValueAsync

Reads the raw value of the IValueSymbol (Ads Read / Write) asynchronously. (Inherited from Symbol.)

UnionInstance Class 49:

ReadValue.

Reads the Value of the IValueSymbol (Inherited from Symbol.)

UnionInstance Class 50:

ReadValue(Int32)

Reads the Value of the IValueSymbol (Inherited from Symbol.)

UnionInstance Class 51:

ReadValueAsync

Reads the Value of the IValueSymbol asynchronously. (Inherited from Symbol.)

UnionInstance Class 52:

SetParent

Sets the parent symbol. (Inherited from Symbol.)

UnionInstance Class 53:

ToString

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

UnionInstance Class 54:

TryReadValue

Reads the Value of the IValueSymbol (Inherited from Symbol.)

UnionInstance Class 55:

TryWriteValue

Writes the Value of the IValueSymbol (Inherited from Symbol.)

UnionInstance Class 56:

UpdateAnyValue(Object.)

Reads the value of this Value into the specified managed value. (Inherited from Symbol.)

UnionInstance Class 57:

UpdateAnyValue(Object., Int32)

Reads the value of this Value into the specified managed value. (Inherited from Symbol.)

UnionInstance Class 58:

WriteRawValue(.Byte.)

Writes the raw value of the IValueSymbol (Ads Read / Write) (Inherited from Symbol.)

UnionInstance Class 59:

WriteRawValue(.Byte., Int32)

Writes the raw value of the IValueSymbol (Ads Read / Write) (Inherited from Symbol.)

UnionInstance Class 60:

WriteRawValueAsync

Writes the raw value of the IValueSymbol (Ads Read / Write) (Inherited from Symbol.)

UnionInstance Class 61:

WriteValue(Object)

Writes the Value of the IValueSymbol (Inherited from Symbol.)

UnionInstance Class 62:

WriteValue(Object, Int32)

Writes the Value of the IValueSymbol (Inherited from Symbol.)

UnionInstance Class 63:

WriteValueAsync

Writes the Value of the IValueSymbol (Inherited from Symbol.)

Events

 

Name

Description

UnionInstance Class 64:

RawValueChanged

Occurs when the RawValue of the IValueSymbol has changed. (Inherited from Symbol.)

UnionInstance Class 65:

ValueChanged

Occurs when the (Primitive) value of the IValueSymbol has changed. (Inherited from Symbol.)

Reference

TwinCAT.Ads.TypeSystem Namespace