IValueSymbol Interface

Interface for a ISymbol that supports values.

Namespace:  TwinCAT.TypeSystem
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

public interface IValueSymbol : IValueRawSymbol, 
    IHierarchicalSymbol, ISymbol, IAttributedInstance, IInstance, IBitSize

The IValueSymbol type exposes the following members.

Properties

 

Name

Description

IValueSymbol Interface 1:

AccessRights

Gets the access rights.

IValueSymbol Interface 2:

Attributes

Gets the Type Attributes. (Inherited from IAttributedInstance.)

IValueSymbol Interface 3:

BitSize

Gets the size of the IDataType in bits. (Inherited from IBitSize.)

IValueSymbol Interface 4:

ByteSize

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

IValueSymbol Interface 5:

Category

Gets the Symbol/Datatype Category (Inherited from ISymbol.)

IValueSymbol Interface 6:

Comment

Gets the comment of the IInstance (Inherited from IInstance.)

IValueSymbol Interface 7:

Connection

Gets the connection that produces values for this IValueSymbol

IValueSymbol Interface 8:

DataType

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

IValueSymbol Interface 9:

HasValue

Gets a value indicating whether this IValueSymbol has a value. (Inherited from IValueRawSymbol.)

IValueSymbol Interface 10:

InstanceName

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

IValueSymbol Interface 11:

InstancePath

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

IValueSymbol Interface 12:

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

IValueSymbol Interface 13:

IsByteAligned

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

IValueSymbol Interface 14:

IsContainerType

Gets a value indicating whether this Symbol is acontainer type. (Inherited from ISymbol.)

IValueSymbol Interface 15:

IsPersistent

Gets a value indicating whether this ISymbol is persistent. (Inherited from ISymbol.)

IValueSymbol Interface 16:

IsPointer

Indicates that the IInstance represents a Pointer type (Pointer TO) (Inherited from IInstance.)

IValueSymbol Interface 17:

IsPrimitiveType

Gets a value indicating whether this instance is a primitive type. (Inherited from ISymbol.)

IValueSymbol Interface 18:

IsReadOnly

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

IValueSymbol Interface 19:

IsRecursive

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

IValueSymbol Interface 20:

IsReference

Indicates that the IInstance represents a Reference type (REFERENCE TO) (Inherited from IInstance.)

IValueSymbol Interface 21:

IsStatic

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

IValueSymbol Interface 22:

NotificationSettings

Gets or sets the notification settings.

IValueSymbol Interface 23:

Parent

Gets the parent Symbol (Inherited from ISymbol.)

IValueSymbol Interface 24:

Size

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

IValueSymbol Interface 25:

SubSymbols

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

IValueSymbol Interface 26:

TypeName

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

IValueSymbol Interface 27:

ValueAccessor

Gets the value accessor. (Inherited from IValueRawSymbol.)

IValueSymbol Interface 28:

ValueEncoding

Gets the value encoding. (Inherited from IAttributedInstance.)

Methods

 

Name

Description

IValueSymbol Interface 29:

ReadRawValue.

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

IValueSymbol Interface 30:

ReadRawValue(Int32)

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

IValueSymbol Interface 31:

ReadRawValueAsync

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

IValueSymbol Interface 32:

ReadValue.

Reads the Value of the IValueSymbol

IValueSymbol Interface 33:

ReadValue(Int32)

Reads the Value of the IValueSymbol

IValueSymbol Interface 34:

ReadValueAsync

Reads the Value of the IValueSymbol asynchronously.

IValueSymbol Interface 35:

SetParent

Sets the parent of the Symbol (Inherited from IHierarchicalSymbol.)

IValueSymbol Interface 36:

TryReadValue

Reads the Value of the IValueSymbol

IValueSymbol Interface 37:

TryWriteValue

Writes the Value of the IValueSymbol

IValueSymbol Interface 38:

WriteRawValue(.Byte.)

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

IValueSymbol Interface 39:

WriteRawValue(.Byte., Int32)

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

IValueSymbol Interface 40:

WriteRawValueAsync

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

IValueSymbol Interface 41:

WriteValue(Object)

Writes the Value of the IValueSymbol

IValueSymbol Interface 42:

WriteValue(Object, Int32)

Writes the Value of the IValueSymbol

IValueSymbol Interface 43:

WriteValueAsync

Writes the Value of the IValueSymbol

Events

 

Name

Description

IValueSymbol Interface 44:

RawValueChanged

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

IValueSymbol Interface 45:

ValueChanged

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

Extension Methods

 

Name

Description

IValueSymbol Interface 46:

PollValues(IObservable.Unit.)

Overloaded.

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

IValueSymbol Interface 47:

IValueSymbol Interface 48:

PollValues(TimeSpan)

Overloaded.

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

IValueSymbol Interface 49:

PollValues(IObservable.Unit., Boolean)

Overloaded.

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

IValueSymbol Interface 50:

IValueSymbol Interface 51:

PollValues(TimeSpan, Boolean)

Overloaded.

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

IValueSymbol Interface 52:

PollValues.T.(IObservable.Unit.)

Overloaded.

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

IValueSymbol Interface 53:

IValueSymbol Interface 54:

PollValues.T.(TimeSpan)

Overloaded.

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

IValueSymbol Interface 55:

IValueSymbol Interface 56:

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

Overloaded.

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

IValueSymbol Interface 57:

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

Overloaded.

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

IValueSymbol Interface 58:

PollValues.T.(TimeSpan, Boolean)

Overloaded.

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

IValueSymbol Interface 59:

PollValues2(IObservable.Unit.)

Overloaded.

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

IValueSymbol Interface 60:

PollValues2(TimeSpan)

Overloaded.

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

IValueSymbol Interface 61:

ReferencesExternalData

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

IValueSymbol Interface 62:

IValueSymbol Interface 63:

WhenValueChanged

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

IValueSymbol Interface 64:

IValueSymbol Interface 65:

WriteValues(IObservable.Object.)

Overloaded.

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

IValueSymbol Interface 66:

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

Overloaded.

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

IValueSymbol Interface 67:

WriteValues(IObservable.Object., CancellationToken)

Overloaded.

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

IValueSymbol Interface 68:

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

Reference

TwinCAT.TypeSystem Namespace

TwinCAT.TypeSystem.IValueRawSymbol