.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.AxisInformation Class Reference

Defines the information for auxiliary axis for ArrayItemType Variables. More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 AxisInformation ()
 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 ()
 

Properties

EUInformation EngineeringUnits [get, set]
 Holds the information about the engineering units for a given axis. More...
 
Range EURange [get, set]
 Limits of the range of the axis More...
 
LocalizedText Title [get, set]
 User readable axis title. More...
 
AxisScaleEnumeration AxisScaleType [get, set]
 LINEAR, LOG, LN, defined by AxisSteps (see AxisScaleEnumeration). More...
 
DoubleCollection AxisSteps [get, set]
 Specific value of each axis step. 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

Defines the information for auxiliary axis for ArrayItemType Variables.

There are three typical uses of this structure:

  1. The step between points is constant and can be predicted using the range information and the number of points. In this case, axisSteps can be set to NULL.
  2. The step between points is not constant, but remains the same for a long period of time (from acquisition to acquisition for example). In this case, axisSteps contains the value of each step on the axis.
  3. The step between points is not constant and changes at every update. In this case, a type like XYArrayType shall be used and axisSteps is set to NULL.

When the steps in the axis are constant, axisSteps may be set to “Null” and in this case, the Range limits are used to compute the steps. The number of steps in the axis comes from the parent ArrayItem.ArrayDimensions.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.AxisInformation.AxisInformation ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.AxisInformation.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

AxisScaleEnumeration UnifiedAutomation.UaBase.AxisInformation.AxisScaleType
getset

LINEAR, LOG, LN, defined by AxisSteps (see AxisScaleEnumeration).

DoubleCollection UnifiedAutomation.UaBase.AxisInformation.AxisSteps
getset

Specific value of each axis step.

May be set to “Null” if not used.

EUInformation UnifiedAutomation.UaBase.AxisInformation.EngineeringUnits
getset

Holds the information about the engineering units for a given axis.

Range UnifiedAutomation.UaBase.AxisInformation.EURange
getset

Limits of the range of the axis

LocalizedText UnifiedAutomation.UaBase.AxisInformation.Title
getset

User readable axis title.

This is useful when the units are%. The Title may be e.g. “Particle size distribution”


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