IAdsSymbol Interface

Interface IAdsSymbol


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

Syntax

C#

public interface IAdsSymbol : ISymbol, 
    IAttributedInstance, IInstance, IBitSize, IProcessImageAddress, IContextMaskProvider

The IAdsSymbol type exposes the following members.

Properties

 

Name

Description

IAdsSymbol Interface 1:

Attributes

Gets the Type Attributes.
(Inherited from IAttributedInstance)

IAdsSymbol Interface 2:

BitSize

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

IAdsSymbol Interface 3:

ByteSize

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

IAdsSymbol Interface 4:

Category

Gets the Symbol/Datatype Category
(Inherited from ISymbol)

IAdsSymbol Interface 5:

Comment

Gets the comment of the IInstance
(Inherited from IInstance)

IAdsSymbol Interface 6:

ContextMask

Gets the ContextMask of the symbol, indicating the task the variable belongs to. If ContextMask is not zero use CyclicInContext or OnChangeInContext to add notifications.
(Inherited from IContextMaskProvider)

IAdsSymbol Interface 7:

DataType

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

IAdsSymbol Interface 8:

DataTypeId

DataType identifier of the Symbol AdsDataTypeId

IAdsSymbol Interface 9:

ImageBaseAddress

Gets the AmsAddress of the Process Image

IAdsSymbol Interface 10:

IndexGroup

Gets the index group of the Symbol
(Inherited from IProcessImageAddress)

IAdsSymbol Interface 11:

IndexOffset

Gets the index offset of the Symbol
(Inherited from IProcessImageAddress)

IAdsSymbol Interface 12:

InstanceName

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

IAdsSymbol Interface 13:

InstancePath

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

IAdsSymbol Interface 14:

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)

IAdsSymbol Interface 15:

IsByteAligned

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

IAdsSymbol Interface 16:

IsContainerType

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

IAdsSymbol Interface 17:

IsPersistent

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

IAdsSymbol Interface 18:

IsPointer

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

IAdsSymbol Interface 19:

IsPrimitiveType

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

IAdsSymbol Interface 20:

IsProperty

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

IAdsSymbol Interface 21:

IsReadOnly

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

IAdsSymbol Interface 22:

IsRecursive

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

IAdsSymbol Interface 23:

IsReference

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

IAdsSymbol Interface 24:

IsStatic

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

IAdsSymbol Interface 25:

IsVirtual

Gets a value indicating whether this instance is virtual.
(Inherited from IProcessImageAddress)

IAdsSymbol Interface 26:

Parent

Gets the parent Symbol
(Inherited from ISymbol)

IAdsSymbol Interface 27:

Size

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

IAdsSymbol Interface 28:

SubSymbols

Gets the SubSymbols of the ISymbol
(Inherited from ISymbol)

IAdsSymbol Interface 29:

TypeName

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

IAdsSymbol Interface 30:

ValueEncoding

Gets the value encoding.
(Inherited from IAttributedInstance)

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)

Unwrap

Gets the Unwrapped Symbol
(Defined by SymbolExtensions)

Reference

TwinCAT.Ads.TypeSystem Namespace ISymbol IProcessImageAddress

Beckhoff Automation GmbH & Co. KG 2001-2026