Symbol Class

Symbol class

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 class Symbol : Instance, IEquatable<Symbol>, 
    IValueSymbol, IValueRawSymbol, IHierarchicalSymbol, ISymbol, IAttributedInstance, 
    IInstance, IBitSize, IValueAnySymbol, IValueAccessorProvider, ISymbolFactoryServicesProvider, 
    IAdsSymbol, IProcessImageAddress, IContextMaskProvider

The Symbol type exposes the following members.

Properties

 

Name

Description

Symbol Class 1:

AccessRights

Gets the access rights.

Symbol Class 2:

Attributes

Gets the Type Attributes. (Inherited from Instance.)

Symbol Class 3:

BitSize

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

Symbol Class 4:

ByteSize

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

Symbol Class 5:

Category

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

Symbol Class 6:

Comment

Gets the comment. (Inherited from Instance.)

Symbol Class 7:

Connection

Gets the connection that produces values for this IValueSymbol

Symbol Class 8:

ContextMask

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

Symbol Class 9:

DataType

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

Symbol Class 10:

HasValue

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

Symbol Class 11:

ImageBaseAddress

Gets the AmsAddress of the Process Image

Symbol Class 12:

IndexGroup

Gets the index group of the Symbol

Symbol Class 13:

IndexOffset

Gets the index offset of the Symbol

Symbol Class 14:

InstanceName

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

Symbol Class 15:

InstancePath

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

Symbol Class 16:

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

Symbol Class 17:

IsByteAligned

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

Symbol Class 18:

IsContainerType

Gets a value indicating whether the Symbols datatype is a Container type.

Symbol Class 19:

IsDereferencedPointer

Gets or sets a value indicating whether an ancestor is a dereferenced Pointer

Symbol Class 20:

IsDereferencedReference

Gets or sets a value indicating whether an ancestor is a dereferenced Reference

Symbol Class 21:

IsPersistent

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

Symbol Class 22:

IsPointer

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

Symbol Class 23:

IsPrimitiveType

Gets a value indicating whether this instance is primitive.

Symbol Class 24:

IsReadOnly

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

Symbol Class 25:

IsRecursive

Gets a value indicating whether this instance is recursive.

Symbol Class 26:

IsReference

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

Symbol Class 27:

IsStatic

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

Symbol Class 28:

IsTcComInterfacePointer

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

Symbol Class 29:

IsTypeGuid

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

Symbol Class 30:

IsVirtual

Gets a value indicating whether this instance is virtual.

Symbol Class 31:

Namespace

Gets the namespace name. (Inherited from Instance.)

Symbol Class 32:

NotificationSettings

Gets or sets the notification settings.

Symbol Class 33:

Parent

Gets the parent Symbol

Symbol Class 34:

Size

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

Symbol Class 35:

SubSymbolCount

Gets the number of SubSymbols

Symbol Class 36:

SubSymbols

Gets the SubSymbols of the ISymbol

Symbol Class 37:

TypeName

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

Symbol Class 38:

ValueEncoding

Gets the value encoding.

Methods

 

Name

Description

Symbol Class 39:

EnsureRights

Ensures that the AccessRights are matched.

Symbol Class 40:

Equals(ISymbol)

Equalses the specified inst.

Symbol Class 41:

Equals(Object)

Equals (Overrides Object.Equals(Object).)

Symbol Class 42:

Equals(Symbol)

Equalses the specified inst.

Symbol Class 43:

Finalize

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

Symbol Class 44:

GetHashCode

Gets the HashCode of the Address (Overrides Object.GetHashCode..)

Symbol Class 45:

GetType

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

Symbol Class 46:

MemberwiseClone

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

Symbol Class 47:

OnGetSize

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

Symbol Class 48:

OnReadRawValue

Handler function for reading the raw value

Symbol Class 49:

OnReadRawValueAsync

Handler function for reading the raw value

Symbol Class 50:

OnReadValue

Handler function for reading the dynamic value.

Symbol Class 51:

OnReadValueAsync

Handler function for reading the dynamic value.

Symbol Class 52:

OnSetInstanceName

Sets a new InstanceName InstancePath (Overrides Instance.OnSetInstanceName(String).)

Symbol Class 53:

OnTryReadValue

Handler function for reading the dynamic value.

Symbol Class 54:

OnTryWriteValue

Handler function for writing the dynamic value

Symbol Class 55:

OnWriteRawValue

Handler function for writing the RawValue

Symbol Class 56:

OnWriteRawValueAsync

Handler function Writing the raw value asynchronously.

Symbol Class 57:

OnWriteValue

Handler function for writing the dynamic value

Symbol Class 58:

OnWriteValueAsync

Handler function for writing the dynamic value

Symbol Class 59:

ReadAnyValue(Type)

Reads the value of this Value into a new created instance of the managed type

Symbol Class 60:

ReadAnyValue(Type, Int32)

Reads the value of this Value into a new created instance of the managed type

Symbol Class 61:

ReadAnyValue.T..

Reads the value of this Value into a new created instance of the managed type

Symbol Class 62:

ReadAnyValue.T.(Int32)

Reads the value of this Value into a new created instance of the managed type

Symbol Class 63:

ReadAnyValueAsync(Type, CancellationToken)

Reads the (AnyType) value asynchronously.

Symbol Class 64:

ReadAnyValueAsync.T.(CancellationToken)

Read any value as an asynchronous operation.

Symbol Class 65:

ReadRawValue.

Reads the raw value of the IValueSymbol (Ads Read / Write)

Symbol Class 66:

ReadRawValue(Int32)

Reads the raw value of the IValueSymbol (Ads Read / Write)

Symbol Class 67:

ReadRawValueAsync

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

Symbol Class 68:

ReadValue.

Reads the Value of the IValueSymbol

Symbol Class 69:

ReadValue(Int32)

Reads the Value of the IValueSymbol

Symbol Class 70:

ReadValueAsync

Reads the Value of the IValueSymbol asynchronously.

Symbol Class 71:

SetAttributes

Sets the type attributes (Inherited from Instance.)

Symbol Class 72:

SetContextMask

Sets the context mask. (Inherited from Instance.)

Symbol Class 73:

SetParent

Sets the parent symbol.

Symbol Class 74:

ToString

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

Symbol Class 75:

TryReadValue

Reads the Value of the IValueSymbol

Symbol Class 76:

TryWriteValue

Writes the Value of the IValueSymbol

Symbol Class 77:

UpdateAnyValue(Object.)

Reads the value of this Value into the specified managed value.

Symbol Class 78:

UpdateAnyValue(Object., Int32)

Reads the value of this Value into the specified managed value.

Symbol Class 79:

WriteRawValue(.Byte.)

Writes the raw value of the IValueSymbol (Ads Read / Write)

Symbol Class 80:

WriteRawValue(.Byte., Int32)

Writes the raw value of the IValueSymbol (Ads Read / Write)

Symbol Class 81:

WriteRawValueAsync

Writes the raw value of the IValueSymbol (Ads Read / Write)

Symbol Class 82:

WriteValue(Object)

Writes the Value of the IValueSymbol

Symbol Class 83:

WriteValue(Object, Int32)

Writes the Value of the IValueSymbol

Symbol Class 84:

WriteValueAsync

Writes the Value of the IValueSymbol

Events

 

Name

Description

Symbol Class 85:

RawValueChanged

Occurs when the RawValue of the IValueSymbol has changed.

Symbol Class 86:

ValueChanged

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

Operators

 

Name

Description

Symbol Class 87:

Symbol Class 88:

Equality

Operator==

Symbol Class 89:

Symbol Class 90:

Inequality

Implements the != operator.

Fields

 

Name

Description

Symbol Class 91:

syncObject

Synchronization object

Extension Methods

 

Name

Description

Symbol Class 92:

PollValues(IObservable.Unit.)

Overloaded.

Poll symbol values on trigger signals. (Defined by ValueSymbolExtensions.)

Symbol Class 93:

Symbol Class 94:

PollValues(TimeSpan)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by ValueSymbolExtensions.)

Symbol Class 95:

PollValues(IObservable.Unit., Boolean)

Overloaded.

Polls symbol values on trigger signals. (Defined by ValueSymbolExtensions.)

Symbol Class 96:

Symbol Class 97:

PollValues(TimeSpan, Boolean)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time. (Defined by ValueSymbolExtensions.)

Symbol Class 98:

PollValues.T.(IObservable.Unit.)

Overloaded.

Poll symbol values as a value sequence on trigger signals (typed) (Defined by ValueSymbolExtensions.)

Symbol Class 99:

Symbol Class 100:

PollValues.T.(TimeSpan)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time (typed) (Defined by ValueSymbolExtensions.)

Symbol Class 101:

Symbol Class 102:

PollValues.T.(IObservable.Unit., Func.ResultReadValueAccess2.IValueSymbol, Object., T.)

Overloaded.

Poll symbol values on trigger signals (typed) (Defined by ValueSymbolExtensions.)

Symbol Class 103:

PollValues.T.(IObservable.Unit., Boolean)

Overloaded.

Poll symbol values on trigger signals (typed) (Defined by ValueSymbolExtensions.)

Symbol Class 104:

PollValues.T.(TimeSpan, Boolean)

Overloaded.

Polls the symbol as value sequence of object values with a specified period time (typed) (Defined by ValueSymbolExtensions.)

Symbol Class 105:

PollValues2(IObservable.Unit.)

Overloaded.

Poll symbol values as a sequence of annotated results (Value + ErrorCode) (Defined by ValueSymbolExtensions.)

Symbol Class 106:

PollValues2(TimeSpan)

Overloaded.

Poll symbol values with communication return codes. (Defined by ValueSymbolExtensions.)

Symbol Class 107:

ReferencesExternalData

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

Symbol Class 108:

Symbol Class 109:

WhenValueChanged

Gets an observable sequence when the value of the IValueSymbol has changed. (Defined by ValueSymbolExtensions.)

Symbol Class 110:

Symbol Class 111:

WriteValues(IObservable.Object.)

Overloaded.

Subscribes the IValueSymbol to an observable sequence of values and writes them to the IValueSymbol. (Defined by ValueSymbolExtensions.)

Symbol Class 112:

WriteValues(IObservable.Object., Action.Exception.)

Overloaded.

Subscribes the IValueSymbol to an observable sequence of values and writes them to the IValueSymbol. (Defined by ValueSymbolExtensions.)

Symbol Class 113:

WriteValues(IObservable.Object., CancellationToken)

Overloaded.

Subscribes the IValueSymbol to an observable sequence of values and writes them to the IValueSymbol. (Defined by ValueSymbolExtensions.)

Symbol Class 114:

WriteValues(IObservable.Object., Action.Exception., CancellationToken)

Overloaded.

Subscribes the IValueSymbol to an observable sequence of values and writes them to the IValueSymbol. (Defined by ValueSymbolExtensions.)

Remarks

A Symbol is a (named) memory object within the Process Image with a fixed address indicated by Index Group and Index Offset. Symbols can optionally be addressed by instance path and are bound to a specific DataType.

Reference

TwinCAT.Ads.TypeSystem Namespace

TwinCAT.Ads.TypeSystem.Instance

TwinCAT.TypeSystem.IValueSymbol

TwinCAT.TypeSystem.IValueAnySymbol

TwinCAT.TypeSystem.IValueAccessorProvider

TwinCAT.TypeSystem.ISymbolFactoryServicesProvider

TwinCAT.TypeSystem.IHierarchicalSymbol

ISymbolValueChangeNotify

TwinCAT.Ads.TypeSystem.IContextMaskProvider

IInstanceInternal

ISymbolInternal

TwinCAT.Ads.TypeSystem.IAdsSymbol

Further Information
See also