.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.OptionSet Class Reference

This abstract DataType is the base DataType for all DataTypes representing a bit mask. More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 OptionSet ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
void Apply (OptionSet other)
 Applies the valid bits of other to the current value. More...
 
void Initialize (int NoOfBits)
 Creates the Value and ValidBits properties. More...
 

Properties

byte[] Value [get, set]
 Array of bytes representing the bits in the option set. More...
 
byte[] ValidBits [get, set]
 Array of bytes with same size as value representing the valid bits in the value parameter. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

This abstract DataType is the base DataType for all DataTypes representing a bit mask.

All OptionSet DataTypes representing bit masks shall inherit from this DataType.

The DataType Nodes representing concrete subtypes of the OptionSet shall have an OptionSetValues Property.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.OptionSet.OptionSet ( )
inline

The default constructor.

Member Function Documentation

void UnifiedAutomation.UaBase.OptionSet.Apply ( OptionSet  other)
inline

Applies the valid bits of other to the current value.

The bits set in the Value property of other are written to the Value property of this if the bit is set in ValidBits property of other and this.

Parameters
other
void UnifiedAutomation.UaBase.OptionSet.Initialize ( int  NoOfBits)
inline

Creates the Value and ValidBits properties.

The bits in Value will not be set. All bits in ValidBits will be set.

Parameters
NoOfBits
virtual bool UnifiedAutomation.UaBase.OptionSet.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

byte [] UnifiedAutomation.UaBase.OptionSet.ValidBits
getset

Array of bytes with same size as value representing the valid bits in the value parameter.

When the Server returns the value to the Client, the ValidBits provides information of which bits in the bit mask have a meaning. When the Client passes the value to the Server, the ValidBits defines which bits should be written. Only those bits defined in ValidBits are changed in the bit mask, all others stay the same.

byte [] UnifiedAutomation.UaBase.OptionSet.Value
getset

Array of bytes representing the bits in the option set.

The length of the ByteString depends on the number of bits.


The documentation for this class was generated from the following files: