IValueSymbol2 Interface

Interface for a ISymbol that supports values.

Namespace:  TwinCAT.TypeSystem
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

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

VB

Public Interface IValueSymbol2
    Inherits IValueSymbol, IValueRawSymbol, ISymbol, IAttributedInstance, 
    IInstance, IBitSize

The IValueSymbol2 type exposes the following members.

Properties

 

Name

Description

IValueSymbol2 Interface 1:

AccessRights

Gets the access rights. (Inherited from IValueSymbol.)

IValueSymbol2 Interface 2:

Attributes

Gets the Type Attributes. (Inherited from IAttributedInstance.)

IValueSymbol2 Interface 3:

BitSize

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

IValueSymbol2 Interface 4:

ByteSize

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

IValueSymbol2 Interface 5:

Category

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

IValueSymbol2 Interface 6:

Comment

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

IValueSymbol2 Interface 7:

Connection

Gets the connection that produces values for this IValueSymbol

IValueSymbol2 Interface 8:

DataType

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

IValueSymbol2 Interface 9:

HasValue

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

IValueSymbol2 Interface 10:

InstanceName

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

IValueSymbol2 Interface 11:

InstancePath

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

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

IValueSymbol2 Interface 13:

IsByteAligned

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

IValueSymbol2 Interface 14:

IsContainerType

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

IValueSymbol2 Interface 15:

IsPersistent

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

IValueSymbol2 Interface 16:

IsPointer

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

IValueSymbol2 Interface 17:

IsPrimitiveType

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

IValueSymbol2 Interface 18:

IsReadOnly

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

IValueSymbol2 Interface 19:

IsRecursive

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

IValueSymbol2 Interface 20:

IsReference

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

IValueSymbol2 Interface 21:

IsStatic

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

IValueSymbol2 Interface 22:

NotificationSettings

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

IValueSymbol2 Interface 23:

Parent

Gets the parent Symbol (Inherited from ISymbol.)

IValueSymbol2 Interface 24:

Size

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

IValueSymbol2 Interface 25:

SubSymbols

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

IValueSymbol2 Interface 26:

TypeName

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

Methods

 

Name

Description

IValueSymbol2 Interface 27:

ReadRawValue.

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

IValueSymbol2 Interface 28:

ReadRawValue(Int32)

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

IValueSymbol2 Interface 29:

ReadValue.

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

IValueSymbol2 Interface 30:

ReadValue(Int32)

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

IValueSymbol2 Interface 31:

WriteRawValue(.Byte.)

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

IValueSymbol2 Interface 32:

WriteRawValue(.Byte., Int32)

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

IValueSymbol2 Interface 33:

WriteValue(Object)

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

IValueSymbol2 Interface 34:

WriteValue(Object, Int32)

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

Events

 

Name

Description

IValueSymbol2 Interface 35:

RawValueChanged

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

IValueSymbol2 Interface 36:

ValueChanged

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

Extension Methods

 

Name

Description

IValueSymbol2 Interface 37:

PollValuesAnnotated(IObservable.Unit.)

Overloaded.

Polls the values as ValueChangedArgs sequence annotated value on trigger sequence (Defined by ValueSymbolExtensions.)

IValueSymbol2 Interface 38:

PollValuesAnnotated(TimeSpan)

Overloaded.

Polls the values as ValueChangedArgs sequence with a specified period time. (Defined by ValueSymbolExtensions.)

IValueSymbol2 Interface 39:

IValueSymbol2 Interface 40:

WhenValueChanged

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

IValueSymbol2 Interface 41:

IValueSymbol2 Interface 42:

WriteValues(IObservable.Object.)

Overloaded.

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

IValueSymbol2 Interface 43:

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

Overloaded.

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

IValueSymbol2 Interface 44:

WriteValues(IObservable.Object., CancellationToken)

Overloaded.

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

IValueSymbol2 Interface 45:

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