IValueSymbol3 Interface

Interface IValueSymbol3 Implements the IValueSymbol2

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

Syntax

C#

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

VB

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

The IValueSymbol3 type exposes the following members.

Properties

 

Name

Description

AccessRights

Gets the access rights. (Inherited from IValueSymbol.)

Attributes

Gets the Type Attributes. (Inherited from IAttributedInstance.)

BitSize

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

ByteSize

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

Category

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

Comment

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

Connection

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

DataType

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

HasValue

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

InstanceName

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

InstancePath

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

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

IsByteAligned

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

IsContainerType

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

IsPersistent

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

IsPointer

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

IsPrimitiveType

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

IsReadOnly

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

IsRecursive

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

IsReference

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

IsStatic

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

NotificationSettings

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

Parent

Gets the parent Symbol (Inherited from ISymbol.)

Size

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

SubSymbols

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

TypeName

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

Methods

 

Name

Description

ReadRawValue.

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

ReadRawValue(Int32)

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

ReadValue.

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

ReadValue(Int32)

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

TryReadValue

Reads the Value of the IValueSymbol

TryWriteValue

Writes the Value of the IValueSymbol

WriteRawValue(.Byte.)

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

WriteRawValue(.Byte., Int32)

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

WriteValue(Object)

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

WriteValue(Object, Int32)

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

Events

 

Name

Description

RawValueChanged

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

ValueChanged

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

Extension Methods

 

Name

Description

PollValuesAnnotated(IObservable.Unit.)

Overloaded.

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

PollValuesAnnotated(TimeSpan)

Overloaded.

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

WhenValueChanged

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

WriteValues(IObservable.Object.)

Overloaded.

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

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

Overloaded.

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

WriteValues(IObservable.Object., CancellationToken)

Overloaded.

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

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