Click or drag to resize

ComputedValue Class

Represents an attribute value that's computed at runtime.
Inheritance Hierarchy

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

The ComputedValue type exposes the following members.

Constructors
  NameDescription
Public methodComputedValue
Constructs a ComputedValue.
Top
Properties
  NameDescription
Public propertyAttributeId
Attribute ID.
(Inherited from AttributeProperties.)
Public propertyDimensions
The dimensions of the value (or null).
(Overrides AttributeValueDimensions.)
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).
(Inherited from AttributeValue.)
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.
(Inherited from AttributeValue.)
Protected methodGetValue(MessageContextBase, IPacketWriter)
When overriden in a derived class, computes and returns the current value.
Public methodGetValue(MessageContextBase, ArraySegmentByte)
Protocol access to the attribute value. Honours Gettable.
(Overrides AttributeValueGetValue(MessageContextBase, ArraySegmentByte).)
Public methodGetValue(MessageContextBase, IPacketWriter, DataSelect)
Protocol access to the attribute value. Honours Gettable.
(Overrides AttributeValueGetValue(MessageContextBase, IPacketWriter, DataSelect).)
Public methodNotifyAttributeValueSet
Raises the OnAttributeValueSet event.
(Inherited from AttributeValue.)
Public methodReadByte
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadByte.)
Public methodReadBytes(ArraySegmentByte)
Read data out of the attribute value into the specified buffer.
(Overrides AttributeValueReadBytes(ArraySegmentByte).)
Public methodReadBytes(Int32)
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadBytes(Int32).)
Public methodReadDoubleLE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadDoubleLE.)
Public methodReadInt16LE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadInt16LE.)
Public methodReadInt32LE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadInt32LE.)
Public methodReadInt64LE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadInt64LE.)
Public methodReadSingleLE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadSingleLE.)
Public methodReadString
Reads the attribute value from the specified offset and returns the data as a value.
(Overrides AttributeValueReadString(BinaryTextEncoding).)
Public methodReadUInt16LE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadUInt16LE.)
Public methodReadUInt32LE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadUInt32LE.)
Public methodReadUInt64LE
Reads the attribute value and returns the data as a value.
(Overrides AttributeValueReadUInt64LE.)
Public methodRemoveOnAttributeValueSet
Remove a handler from the OnAttributeValueSet event.
(Inherited from AttributeValue.)
Protected methodSetValue(MessageContextBase, IPacketWriter, IPacketReader)
When overriden in a derived class, updates the current value.
Public methodSetValue(MessageContextBase, ArraySegmentByte, Boolean)
Protocol access to the attribute value. Honours Settable and IgnoreSet.
(Overrides AttributeValueSetValue(MessageContextBase, ArraySegmentByte, Boolean).)
Public methodSetValue(MessageContextBase, IPacketWriter, IPacketReader, DataSelect, Boolean)
Protocol access to the attribute value. Honours Settable and IgnoreSet.
(Overrides AttributeValueSetValue(MessageContextBase, IPacketWriter, IPacketReader, DataSelect, Boolean).)
Public methodWriteByte
Write a value to the attribute value.
(Overrides AttributeValueWriteByte(Byte).)
Public methodWriteBytes
Write data into the attribute value from the specified buffer.
(Overrides AttributeValueWriteBytes(ArraySegmentByte).)
Public methodWriteDoubleLE
Write a value to the attribute value.
(Overrides AttributeValueWriteDoubleLE(Double).)
Public methodWriteInt16LE
Write a value to the attribute value.
(Overrides AttributeValueWriteInt16LE(Int16).)
Public methodWriteInt32LE
Write a value to the attribute value.
(Overrides AttributeValueWriteInt32LE(Int32).)
Public methodWriteInt64LE
Write a value to the attribute value.
(Overrides AttributeValueWriteInt64LE(Int64).)
Public methodWriteSingleLE
Write a value to the attribute value.
(Overrides AttributeValueWriteSingleLE(Single).)
Public methodWriteString
Write a value to the attribute value.
(Overrides AttributeValueWriteString(BinaryString, BinaryTextEncoding).)
Public methodWriteUInt16LE
Write a value to the attribute value.
(Overrides AttributeValueWriteUInt16LE(UInt16).)
Public methodWriteUInt32LE
Write a value to the attribute value.
(Overrides AttributeValueWriteUInt32LE(UInt32).)
Public methodWriteUInt64LE
Write a value to the attribute value.
(Overrides AttributeValueWriteUInt64LE(UInt64).)
Top
Events
  NameDescription
Public eventOnAttributeValueSet
Occurs when the attribute value is set, but only under certain circumstances (see remarks).
(Inherited from AttributeValue.)
Top
See Also