Symbol Methods

The Symbol type exposes the following members.

Methods

 

Name

Description

Symbol Methods 1:

EnsureRights

Ensures that the AccessRights are matched.

Symbol Methods 2:

Equals(ISymbol)

Equalses the specified inst.

Symbol Methods 3:

Equals(Object)

Equals
(Overrides ObjectEquals(Object))

Symbol Methods 4:

Equals(Symbol)

Equalses the specified inst.

Symbol Methods 5:

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 Methods 6:

GetHashCode

Gets the HashCode of the Address
(Overrides ObjectGetHashCode)

Symbol Methods 7:

GetType

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

Symbol Methods 8:

MemberwiseClone

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

Symbol Methods 9:

OnGetSize

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

Symbol Methods 10:

OnReadRawValue

Handler function for reading the raw value

Symbol Methods 11:

OnReadRawValueAsync

Handler function for reading the raw value

Symbol Methods 12:

OnReadValue

Handler function for reading the dynamic value.

Symbol Methods 13:

OnReadValueAsync

Handler function for reading the dynamic value.

Symbol Methods 14:

OnSetInstanceName

Sets a new InstanceName InstancePath
(Overrides InstanceOnSetInstanceName(String))

Symbol Methods 15:

OnTryReadValue

Handler function for reading the dynamic value.

Symbol Methods 16:

OnTryWriteValue

Handler function for writing the dynamic value

Symbol Methods 17:

OnWriteRawValue

Handler function for writing the RawValue

Symbol Methods 18:

OnWriteRawValueAsync

Handler function Writing the raw value asynchronously.

Symbol Methods 19:

OnWriteValue

Handler function for writing the dynamic value

Symbol Methods 20:

OnWriteValueAsync

Handler function for writing the dynamic value

Symbol Methods 21:

ReadAnyValue(Type)

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

Symbol Methods 22:

ReadAnyValue(Type, Int32)

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

Symbol Methods 23:

ReadAnyValueT

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

Symbol Methods 24:

ReadAnyValueT(Int32)

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

Symbol Methods 25:

ReadAnyValueAsync(Type, CancellationToken)

Reads the (AnyType) value asynchronously.

Symbol Methods 26:

ReadAnyValueAsyncT(CancellationToken)

Read any value as an asynchronous operation.

Symbol Methods 27:

ReadRawValue

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

Symbol Methods 28:

ReadRawValue(Int32)

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

Symbol Methods 29:

ReadRawValueAsync

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

Symbol Methods 30:

ReadValue

Reads the Value of the IValueSymbol

Symbol Methods 31:

ReadValue(Int32)

Reads the Value of the IValueSymbol

Symbol Methods 32:

ReadValueAsync

Reads the Value of the IValueSymbol asynchronously.

Symbol Methods 33:

SetAttributes

Sets the type attributes
(Inherited from Instance)

Symbol Methods 34:

SetContextMask

Sets the context mask.
(Inherited from Instance)

Symbol Methods 35:

SetParent

Sets the parent symbol.

Symbol Methods 36:

ToString

Returns a String that represents this instance.
(Overrides InstanceToString)

Symbol Methods 37:

TryReadValue

Reads the Value of the IValueSymbol

Symbol Methods 38:

TryWriteValue

Writes the Value of the IValueSymbol

Symbol Methods 39:

UpdateAnyValue(Object)

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

Symbol Methods 40:

UpdateAnyValue(Object, Int32)

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

Symbol Methods 41:

WriteRawValue(Byte)

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

Symbol Methods 42:

WriteRawValue(Byte, Int32)

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

Symbol Methods 43:

WriteRawValueAsync

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

Symbol Methods 44:

WriteValue(Object)

Writes the Value of the IValueSymbol

Symbol Methods 45:

WriteValue(Object, Int32)

Writes the Value of the IValueSymbol

Symbol Methods 46:

WriteValueAsync

Writes the Value of the IValueSymbol

Extension Methods

 

Name

Description

HasExternalDataReferences

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

IsExternalDataReference

Indicates, that the field is static or is not part of the parents processimage memory location
(Defined by DataTypeExtension)

PollValues

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

PollValues

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

PollValues

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

PollValues

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

PollValuesT

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

PollValuesT

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

PollValuesT

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

PollValuesT

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

PollValuesT

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

PollValues2

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

PollValues2

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

Unwrap

Gets the Unwrapped Symbol
(Defined by SymbolExtensions)

WhenValueChanged

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

WriteValues

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

WriteValues

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

WriteValues

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

WriteValues

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

Reference

Symbol Class TwinCAT.Ads.TypeSystem Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026