Symbol Class

Inheritance Hierarchy

System.Object
  TwinCAT.Ads.TypeSystem.Instance
    TwinCAT.Ads.TypeSystem.Symbol
      TwinCAT.Ads.TypeSystem.UnionInstance

Namespace: TwinCAT.Ads.TypeSystem
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

C#

public class Symbol : Instance, IEquatable<Symbol>, 
	IValueSymbol, IValueRawSymbol, IHierarchicalSymbol, ISymbol, IAttributedInstance, 
	IInstance, IBitSize, IValueAnySymbol, IValueAccessorProvider, ISymbolFactoryServicesProvider, 
	IAdsSymbol, IProcessImageAddress, IContextMaskProvider

The Symbol type exposes the following members.

Properties

	Name	Description
	AccessRights	Gets the access rights.
	Attributes	Gets the Type Attributes. (Inherited from Instance)
	BitSize	Gets the size of this Instance in bits. (Inherited from Instance)
	ByteSize	Gets the (aligned) size of of the Type/Instance in Bytes (Inherited from Instance)
	Category	Gets the the DataTypeCategory of the Instance. (Inherited from Instance)
	Comment	Gets the comment. (Inherited from Instance)
	Connection	Gets the connection that produces values for this IValueSymbol
	ContextMask	Gets the context mask of this instance. (Inherited from Instance)
	DataType	Gets the IDataType of the IInstance. (Inherited from Instance)
	HasValue	Gets a value indicating whether this instance has a value. (Inherited from Instance)
	ImageBaseAddress	Gets the AmsAddress of the Process Image
	IndexGroup	Gets the index group of the Symbol
	IndexOffset	Gets the index offset of the Symbol
	InstanceName	Gets the name of the instance (without periods (.) (Inherited from Instance)
	InstancePath	Gets the relative / absolute access path to the instance (with periods (.)) (Overrides Instance.InstancePath)
	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 Instance)
	IsByteAligned	Indicates that the Size of the Object is Byte aligned (BitSize % 8 == 0) (Inherited from Instance)
	IsContainerType	Gets a value indicating whether the Symbols datatype is a Container type.
	IsDereferencedPointer	Gets or sets a value indicating whether an ancestor is a dereferenced Pointer
	IsDereferencedReference	Gets or sets a value indicating whether an ancestor is a dereferenced Reference
	IsPersistent	Indicates that this instance is persistent. (Inherited from Instance)
	IsPointer	Gets a value indicating whether this instance is reference. (Inherited from Instance)
	IsPrimitiveType	Gets a value indicating whether this instance is primitive.
	IsProperty	Gets a value indicating whether IInstance is a property. (Inherited from Instance)
	IsReadOnly	Indicates that this instance is read only. (Inherited from Instance)
	IsRecursive	Gets a value indicating whether this instance is recursive.
	IsReference	Gets a value indicating whether this instance is reference. (Inherited from Instance)
	IsStatic	Gets a value indicating whether this IInstance is static. (Inherited from Instance)
	IsTcComInterfacePointer	Indicates that this instance is a TcComInterfacePointer. (Inherited from Instance)
	IsTypeGuid	Indicates that this instance has set TypeGuid flag. (Inherited from Instance)
	IsVirtual	Gets a value indicating whether this instance is virtual.
	Namespace	Gets the namespace name. (Inherited from Instance)
	NotificationSettings	Gets or sets the notification settings.
	Parent	Gets the parent Symbol
	Size	Gets the size of the IDataType in bytes or Bits dependant on IsBitType (Inherited from Instance)
	SubSymbolCount	Gets the number of SubSymbols
	SubSymbols	Gets the SubSymbols of the ISymbol
	TypeName	Gets the name of the DataType that is used for this IInstance. (Inherited from Instance)
	ValueEncoding	Gets the value encoding.

Methods

	Name	Description
	EnsureRights	Ensures that the AccessRights are matched.
	Equals(ISymbol)	Equalses the specified inst.
	Equals(Object)	Equals (Overrides Object.Equals(Object))
	Equals(Symbol)	Equalses the specified inst.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Gets the HashCode of the Address (Overrides Object.GetHashCode())
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnGetSize	Handler function getting the size of the Instance (Inherited from Instance)
	OnReadRawValue	Handler function for reading the raw value
	OnReadRawValueAsync	Handler function for reading the raw value
	OnReadValue	Handler function for reading the dynamic value.
	OnReadValueAsync	Handler function for reading the dynamic value.
	OnSetInstanceName	Sets a new InstanceName InstancePath (Overrides Instance.OnSetInstanceName(String))
	OnTryReadValue	Handler function for reading the dynamic value.
	OnTryWriteValue	Handler function for writing the dynamic value
	OnWriteRawValue	Handler function for writing the RawValue
	OnWriteRawValueAsync	Handler function Writing the raw value asynchronously.
	OnWriteValue	Handler function for writing the dynamic value
	OnWriteValueAsync	Handler function for writing the dynamic value
	ReadAnyValue(Type)	Reads the value of this Value into a new created instance of the managed type
	ReadAnyValue(Type, Int32)	Reads the value of this Value into a new created instance of the managed type
	ReadAnyValue<T>()	Reads the value of this Value into a new created instance of the managed type
	ReadAnyValue<T>(Int32)	Reads the value of this Value into a new created instance of the managed type
	ReadAnyValueAsync(Type, CancellationToken)	Reads the (AnyType) value asynchronously.
	ReadAnyValueAsync<T>(CancellationToken)	Read any value as an asynchronous operation.
	ReadRawValue()	Reads the raw value of the IValueSymbol (Ads Read / Write)
	ReadRawValue(Int32)	Reads the raw value of the IValueSymbol (Ads Read / Write)
	ReadRawValueAsync	Reads the raw value of the IValueSymbol (Ads Read / Write) asynchronously.
	ReadValue()	Reads the Value of the IValueSymbol
	ReadValue(Int32)	Reads the Value of the IValueSymbol
	ReadValueAsync	Reads the Value of the IValueSymbol asynchronously.
	SetAttributes	Sets the type attributes (Inherited from Instance)
	SetContextMask	Sets the context mask. (Inherited from Instance)
	SetParent	Sets the parent symbol.
	ToString	Returns a String that represents this instance. (Overrides Instance.ToString())
	TryReadValue	Reads the Value of the IValueSymbol
	TryWriteValue	Writes the Value of the IValueSymbol
	UpdateAnyValue(Object)	Reads the value of this Value into the specified managed value.
	UpdateAnyValue(Object, Int32)	Reads the value of this Value into the specified managed value.
	WriteRawValue(Byte[])	Writes the raw value of the IValueSymbol (Ads Read / Write)
	WriteRawValue(Byte[], Int32)	Writes the raw value of the IValueSymbol (Ads Read / Write)
	WriteRawValueAsync	Writes the raw value of the IValueSymbol (Ads Read / Write)
	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.
	ValueChanged	Occurs when the value of the IValueSymbol has changed.

Operators

	Name	Description
	Equality(Symbol, Symbol)	Operator==
	Inequality(Symbol, Symbol)	Implements the != operator.

Name

Description

Symbol Class 88:

Symbol Class 89:

Equality(Symbol, Symbol)

Operator==

Symbol Class 90:

Symbol Class 91:

Inequality(Symbol, Symbol)

Implements the != operator.

Fields

	Name	Description
	syncObject	Synchronization object

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)
	PollValues<T>	Poll symbol values as a value sequence on trigger signals (typed) (Defined by ValueSymbolExtensions)
	PollValues<T>	Polls the symbol as value sequence of object values with a specified period time (typed) (Defined by ValueSymbolExtensions)
	PollValues<T>	Poll symbol values on trigger signals (typed) (Defined by ValueSymbolExtensions)
	PollValues<T>	Poll symbol values on trigger signals (typed) (Defined by ValueSymbolExtensions)
	PollValues<T>	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)

Remarks

A Symbol is a (named) memory object within the Process Image with a fixed address indicated by Index Group and Index Offset. Symbols can optionally be addressed by instance path and are bound to a specific DataType.

Reference

TwinCAT.Ads.TypeSystem Namespace Instance IValueSymbol IValueAnySymbol IValueAccessorProvider ISymbolFactoryServicesProvider IHierarchicalSymbolISymbolValueChangeNotifyIContextMaskProviderIInstanceInternalISymbolInternalIAdsSymbol

Beckhoff Automation GmbH & Co. KG 2001-2026