Click or drag to resize

AttributeValue Class

Represents an attribute value, and acts as a base for classes that store/compute the actual attribute value. AttributeValue also stores attribute meta data (dimensions and properties), and provides common abstract methods for accessing attribute values. Typical use of AttributeValue is through an AttributeBase, which provides a strongly typed view on the value.
Inheritance Hierarchy

Namespace:  Demo3D.PLC.Comms.AttrDb
Assembly:  PLC (in PLC.dll) Version: 15.0.2.11458
Syntax
C#
public abstract class AttributeValue : AttributeProperties

The AttributeValue type exposes the following members.

Constructors
  NameDescription
Protected methodAttributeValue
Constructs an AttributeValue.
Top
Properties
  NameDescription
Public propertyAttributeId
Attribute ID.
(Inherited from AttributeProperties.)
Public propertyDimensions
The dimensions of the value (or null).
Public propertyFixedSize
True if the value size is fixed.
(Inherited from AttributeProperties.)
Public propertyFlags
Attribute value flags.
(Inherited from AttributeProperties.)
Public propertyGetAttributesAll
The attribute data is returned in a GetAttributesAll request.
(Inherited from AttributeProperties.)
Public propertyGettable
True if protocol attribute-get requests are allowed.
(Inherited from AttributeProperties.)
Public propertyIgnoreSet
True if protocol attribute-set requests are allowed, but should be ignored.
(Inherited from AttributeProperties.)
Public propertyNotSupported
The attribute is not supported.
(Inherited from AttributeProperties.)
Public propertyNumBytes
The number of bytes of attribute data (or -1).
(Overrides AttributePropertiesNumBytes.)
Public propertySettable
True if protocol attribute-set requests are allowed.
(Inherited from AttributeProperties.)
Top
Methods
  NameDescription
Public methodAddOnAttributeValueSet
Add a handler for the OnAttributeValueSet event.
Public methodGetValue(MessageContextBase, ArraySegmentByte)
Protocol access to the attribute value. Honours Gettable.
Public methodGetValue(MessageContextBase, IPacketWriter, DataSelect)
Protocol access to the attribute value. Honours Gettable.
Public methodNotifyAttributeValueSet
Raises the OnAttributeValueSet event.
Public methodReadByte
Reads the attribute value and returns the data as a value.
Public methodReadBytes(ArraySegmentByte)
Read the attribute value into the specified buffer.
Public methodReadBytes(Int32)
Reads the attribute value and returns the data as a value.
Public methodReadDoubleLE
Reads the attribute value and returns the data as a value.
Public methodReadInt16LE
Reads the attribute value and returns the data as a value.
Public methodReadInt32LE
Reads the attribute value and returns the data as a value.
Public methodReadInt64LE
Reads the attribute value and returns the data as a value.
Public methodReadSingleLE
Reads the attribute value and returns the data as a value.
Public methodReadString
Reads the attribute value and returns the data as a value.
Public methodReadUInt16LE
Reads the attribute value and returns the data as a value.
Public methodReadUInt32LE
Reads the attribute value and returns the data as a value.
Public methodReadUInt64LE
Reads the attribute value and returns the data as a value.
Public methodRemoveOnAttributeValueSet
Remove a handler from the OnAttributeValueSet event.
Public methodSetValue(MessageContextBase, ArraySegmentByte, Boolean)
Protocol access to the attribute value. Honours Settable and IgnoreSet.
Public methodSetValue(MessageContextBase, IPacketWriter, IPacketReader, DataSelect, Boolean)
Protocol access to the attribute value. Honours Settable and IgnoreSet.
Public methodWriteByte
Write a value to the attribute value.
Public methodWriteBytes
Write data into the attribute value.
Public methodWriteDoubleLE
Write a value to the attribute value.
Public methodWriteInt16LE
Write a value to the attribute value.
Public methodWriteInt32LE
Write a value to the attribute value.
Public methodWriteInt64LE
Write a value to the attribute value.
Public methodWriteSingleLE
Write a value to the attribute value.
Public methodWriteString
Write a value to the attribute value.
Public methodWriteUInt16LE
Write a value to the attribute value.
Public methodWriteUInt32LE
Write a value to the attribute value.
Public methodWriteUInt64LE
Write a value to the attribute value.
Top
Events
  NameDescription
Public eventOnAttributeValueSet
Occurs when the attribute value is set, but only under certain circumstances (see remarks).
Top
See Also