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.328+39e3229

Syntax

C#

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

The UnionInstance type exposes the following members.

Properties

 

Name

Description

AccessRights

Gets the access rights. (Inherited from Symbol.)

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

Connection

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

ContextMask

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

DataType

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

FieldInstances

Gets the member instances of the Struct Instance.

HasValue

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

ImageBaseAddress

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

IndexGroup

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

IndexOffset

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

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

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

IsContainerType

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

IsDereferencedPointer

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

IsDereferencedReference

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

IsPersistent

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

IsPointer

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

IsPrimitiveType

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

IsReadOnly

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

IsRecursive

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

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 that this instance is a TcComInterfacePointer. (Inherited from Instance.)

IsTypeGuid

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

IsVirtual

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

Namespace

Gets the namespace name. (Inherited from Instance.)

NotificationSettings

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

Parent

Gets the parent Symbol (Inherited from Symbol.)

Size

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

SubSymbolCount

Gets the number of SubSymbols (Inherited from Symbol.)

SubSymbols

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

TypeName

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

ValueEncoding

Gets the value encoding. (Inherited from Symbol.)

Methods

 

Name

Description

Equals(ISymbol)

Equalses the specified inst. (Inherited from Symbol.)

Equals(Object)

Equals (Inherited from Symbol.)

Equals(Symbol)

Equalses the specified inst. (Inherited from Symbol.)

GetHashCode

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

GetType

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

ReadAnyValue(Type)

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

ReadAnyValue(Type, Int32)

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

ReadAnyValue.T..

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

ReadAnyValue.T.(Int32)

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

ReadAnyValueAsync(Type, CancellationToken)

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

ReadAnyValueAsync.T.(CancellationToken)

Read any value as an asynchronous operation. (Inherited from Symbol.)

ReadRawValue.

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

ReadRawValue(Int32)

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

ReadRawValueAsync

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

ReadValue.

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

ReadValue(Int32)

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

ReadValueAsync

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

SetParent

Sets the parent symbol. (Inherited from Symbol.)

ToString

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

TryReadValue

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

TryWriteValue

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

UpdateAnyValue(Object.)

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

UpdateAnyValue(Object., Int32)

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

WriteRawValue(.Byte.)

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

WriteRawValue(.Byte., Int32)

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

WriteRawValueAsync

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

WriteValue(Object)

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

WriteValue(Object, Int32)

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

WriteValueAsync

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

Events

 

Name

Description

RawValueChanged

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

ValueChanged

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

Extension Methods

 

Name

Description

ReferencesExternalData

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

Reference

TwinCAT.Ads.TypeSystem Namespace