IValueSymbol Interface

C#

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

The IValueSymbol type exposes the following members.

Properties

	Name	Description
	AccessRights	Gets the access rights.
	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
	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 acontainer 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	Indicates that this instance 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.
	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.)
	ValueAccessor	Gets the value accessor. (Inherited from IValueRawSymbol.)
	ValueEncoding	Gets the value encoding. (Inherited from IAttributedInstance.)

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.)
	ReadRawValueAsync	Reads the raw value of the IValueSymbol (Ads Read / Write) asynchronously. (Inherited from IValueRawSymbol.)
	ReadValue.	Reads the Value of the IValueSymbol
	ReadValue(Int32)	Reads the Value of the IValueSymbol
	ReadValueAsync	Reads the Value of the IValueSymbol asynchronously.
	SetParent	Sets the parent of the Symbol (Inherited from IHierarchicalSymbol.)
	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.)
	WriteRawValueAsync	Writes the raw value of the IValueSymbol (Ads Read / Write) (Inherited from IValueRawSymbol.)
	WriteValue(Object)	Writes the Value of the IValueSymbol
	WriteValue(Object, Int32)	Writes the Value of the IValueSymbol
	WriteValueAsync	Writes the Value of the 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.

Extension Methods

	Name	Description
	PollValues(IObservable.Unit.)	Overloaded. Poll symbol values on trigger signals. (Defined by ValueSymbolExtensions.)
	PollValues(TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by ValueSymbolExtensions.)
	PollValues(IObservable.Unit., Boolean)	Overloaded. Polls symbol values on trigger signals. (Defined by ValueSymbolExtensions.)
	PollValues(TimeSpan, Boolean)	Overloaded. Polls the symbol as value sequence of object values with a specified period time. (Defined by ValueSymbolExtensions.)
	PollValues.T.(IObservable.Unit.)	Overloaded. Poll symbol values as a value sequence on trigger signals (typed) (Defined by ValueSymbolExtensions.)
	PollValues.T.(TimeSpan)	Overloaded. Polls the symbol as value sequence of object values with a specified period time (typed) (Defined by ValueSymbolExtensions.)
	PollValues.T.(IObservable.Unit., Func.ResultReadValueAccess2.IValueSymbol, Object., T.)	Overloaded. Poll symbol values on trigger signals (typed) (Defined by ValueSymbolExtensions.)
	PollValues.T.(IObservable.Unit., Boolean)	Overloaded. Poll symbol values on trigger signals (typed) (Defined by ValueSymbolExtensions.)
	PollValues.T.(TimeSpan, Boolean)	Overloaded. Polls the symbol as value sequence of object values with a specified period time (typed) (Defined by ValueSymbolExtensions.)
	PollValues2(IObservable.Unit.)	Overloaded. Poll symbol values as a sequence of annotated results (Value + ErrorCode) (Defined by ValueSymbolExtensions.)
	PollValues2(TimeSpan)	Overloaded. Poll symbol values with communication return codes. (Defined by ValueSymbolExtensions.)
	ReferencesExternalData	Indicates, that the Instance value includes process memory data, that cannot be read in one memory block. (Defined by DataTypeExtension.)
	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.IValueRawSymbol

IValueSymbol Interface

Syntax

C#

Properties

Methods

Events

Extension Methods

Reference