Attribute |
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 HierarchySystemObject
Demo3D.PLC.Comms.AttrDbAttributeProperties
Demo3D.PLC.Comms.AttrDbAttributeValue
Demo3D.PLC.Comms.AttrDbMemoryValue
Demo3D.PLC.Comms.AttrDbAttributeProperties
Demo3D.PLC.Comms.AttrDbAttributeValue
Demo3D.PLC.Comms.AttrDbMemoryValue
Namespace: Demo3D.PLC.Comms.AttrDb
Assembly: PLC (in PLC.dll) Version: 19.00.00
SyntaxC#
public abstract class AttributeValue : AttributeProperties
The AttributeValue type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AttributeValue | Constructs an AttributeValue. |
Properties| Name | Description | |
|---|---|---|
 | AttributeId |
Attribute ID.
(Inherited from AttributeProperties) |
| Dimensions | The dimensions of the value (or null). |
| Dynamic |
True if the value size is dynamic.
(Inherited from AttributeProperties) |
| FixedSize |
True if the value size is fixed.
(Inherited from AttributeProperties) |
| Flags |
Attribute value flags.
(Inherited from AttributeProperties) |
| GetAttributesAll |
The attribute data is returned in a GetAttributesAll request.
(Inherited from AttributeProperties) |
| Gettable |
True if protocol attribute-get requests are allowed.
(Inherited from AttributeProperties) |
| IgnoreSet |
True if protocol attribute-set requests are allowed, but should be ignored.
(Inherited from AttributeProperties) |
| NotSupported |
The attribute is not supported.
(Inherited from AttributeProperties) |
| NumBytes |
The number of bytes of attribute data (or -1).
(Overrides AttributePropertiesNumBytes) |
| Settable |
True if protocol attribute-set requests are allowed.
(Inherited from AttributeProperties) |
Methods| Name | Description | |
|---|---|---|
 | AddOnAttributeValueSet | Add a handler for the OnAttributeValueSet event. |
| GetValue(MessageContextBase, ArraySegmentByte) | Protocol access to the attribute value. Honours Gettable. |
| GetValue(MessageContextBase, IPacketWriter, DataSelect) | Protocol access to the attribute value. Honours Gettable. |
| NotifyAttributeValueSet | Raises the OnAttributeValueSet event. |
| ReadByte | Reads the attribute value and returns the data as a value. |
| ReadBytes(ArraySegmentByte) | Read the attribute value into the specified buffer. |
| ReadBytes(Int32) | Reads the attribute value and returns the data as a value. |
| ReadDoubleLE | Reads the attribute value and returns the data as a value. |
| ReadInt16LE | Reads the attribute value and returns the data as a value. |
| ReadInt32LE | Reads the attribute value and returns the data as a value. |
| ReadInt64LE | Reads the attribute value and returns the data as a value. |
| ReadSingleLE | Reads the attribute value and returns the data as a value. |
| ReadString | Reads the attribute value and returns the data as a value. |
| ReadUInt16LE | Reads the attribute value and returns the data as a value. |
| ReadUInt32LE | Reads the attribute value and returns the data as a value. |
| ReadUInt64LE | Reads the attribute value and returns the data as a value. |
| RemoveOnAttributeValueSet | Remove a handler from the OnAttributeValueSet event. |
| SetValue(MessageContextBase, ArraySegmentByte, Boolean) | Protocol access to the attribute value. Honours Settable and IgnoreSet. |
| SetValue(MessageContextBase, IPacketWriter, IPacketReader, DataSelect, Boolean) | Protocol access to the attribute value. Honours Settable and IgnoreSet. |
| WriteByte | Write a value to the attribute value. |
| WriteBytes | Write data into the attribute value. |
| WriteDoubleLE | Write a value to the attribute value. |
| WriteInt16LE | Write a value to the attribute value. |
| WriteInt32LE | Write a value to the attribute value. |
| WriteInt64LE | Write a value to the attribute value. |
| WriteSingleLE | Write a value to the attribute value. |
| WriteString | Write a value to the attribute value. |
| WriteUInt16LE | Write a value to the attribute value. |
| WriteUInt32LE | Write a value to the attribute value. |
| WriteUInt64LE | Write a value to the attribute value. |
Events| Name | Description | |
|---|---|---|
 | OnAttributeValueSet | Occurs when the attribute value is set, but only under certain circumstances (see remarks). |
See Also