C++ Based OPC UA Client/Server SDK  1.5.5.355

Wrapper class for the UA stack structure OpcUa_AxisInformation. More...

#include <uaaxisinformation.h>

Public Member Functions

 UaAxisInformation ()
 Constructs an instance of the class UaAxisInformation with empty default values.
 
 UaAxisInformation (const UaAxisInformation &other)
 Constructs an instance of the class UaAxisInformation with values from another UaAxisInformation object. More...
 
 UaAxisInformation (const OpcUa_AxisInformation &other)
 Constructs an instance of the class UaAxisInformation with values from another OpcUa_AxisInformation structure. More...
 
 UaAxisInformation (const UaEUInformation &engineeringUnits, const UaRange &eURange, const UaLocalizedText &title, OpcUa_AxisScaleEnumeration axisScaleType, const UaDoubleArray &axisSteps)
 Constructs an instance of the class UaAxisInformation with values provided in the constructor.
 
 UaAxisInformation (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaAxisInformation initialized with value from a UaExtensionObject. More...
 
 UaAxisInformation (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaAxisInformation initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaAxisInformation ()
 Destroys the UaAxisInformation object.
 
void clear ()
 Clear the data of the UaAxisInformation. More...
 
bool operator== (const UaAxisInformation &other) const
 Compare two UaAxisInformation for equality. More...
 
bool operator!= (const UaAxisInformation &other) const
 Compare two UaAxisInformation for inequality. More...
 
UaAxisInformationoperator= (const UaAxisInformation &other)
 Assignment operator. More...
 
OpcUa_AxisInformationcopy () const
 Copy UaAxisInformation data to a newly allocated OpcUa_AxisInformation. More...
 
void copyTo (OpcUa_AxisInformation *pDst) const
 Copy UaAxisInformation data to an existing OpcUa_AxisInformation structure. More...
 
void attach (OpcUa_AxisInformation *pValue)
 Attaches to an existing OpcUa_AxisInformation structure. More...
 
OpcUa_AxisInformationdetach (OpcUa_AxisInformation *pDst)
 Detaches the internal AxisInformation structure from this class. More...
 
UaEUInformation getEngineeringUnits () const
 Holds the information about the engineering units for a given axis.
 
UaRange getEURange () const
 Limits of the range of the axis.
 
UaLocalizedText getTitle () const
 User readable axis title. More...
 
OpcUa_AxisScaleEnumeration getAxisScaleType () const
 LINEAR, LOG, LN, defined by AxisSteps.
 
void getAxisSteps (UaDoubleArray &axisSteps) const
 Specific value of each axis step. More...
 
void setEngineeringUnits (const UaEUInformation &engineeringUnits)
 Holds the information about the engineering units for a given axis.
 
void setEURange (const UaRange &eURange)
 Limits of the range of the axis.
 
void setTitle (const UaLocalizedText &title)
 User readable axis title. More...
 
void setAxisScaleType (OpcUa_AxisScaleEnumeration axisScaleType)
 LINEAR, LOG, LN, defined by AxisSteps.
 
void setAxisSteps (const UaDoubleArray &axisSteps)
 Specific value of each axis step. More...
 

Static Public Member Functions

static OpcUa_AxisInformationclone (const OpcUa_AxisInformation &source)
 Copy OpcUa_AxisInformation data to a newly allocated OpcUa_AxisInformation. More...
 
static void cloneTo (const OpcUa_AxisInformation &source, OpcUa_AxisInformation &copy)
 Copy OpcUa_AxisInformation data to an existing OpcUa_AxisInformation structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_AxisInformation.

This class encapsulates the native OpcUa_AxisInformation structure and handles memory allocation and cleanup for you. UaAxisInformation uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared AxisInformation it creates a copy for that (copy-on-write). So assigning another UaAxisInformation or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

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

UaAxisInformation::UaAxisInformation ( const UaAxisInformation other)

Constructs an instance of the class UaAxisInformation with values from another UaAxisInformation object.

Parameters
otherthe other UaAxisInformation used to initialize the object
UaAxisInformation::UaAxisInformation ( const OpcUa_AxisInformation other)

Constructs an instance of the class UaAxisInformation with values from another OpcUa_AxisInformation structure.

Parameters
otherthe other OpcUa_AxisInformation used to initialize the object
UaAxisInformation::UaAxisInformation ( const UaExtensionObject extensionObject)

Constructs an instance of the class UaAxisInformation initialized with value from a UaExtensionObject.

Parameters
extensionObjectthe extension object containing the AxisInformation
UaAxisInformation::UaAxisInformation ( const OpcUa_ExtensionObject extensionObject)

Constructs an instance of the class UaAxisInformation initialized with value from an OpcUa_ExtensionObject structure.

Parameters
extensionObjectthe extension object containing the AxisInformation

Member Function Documentation

void UaAxisInformation::attach ( OpcUa_AxisInformation pValue)

Attaches to an existing OpcUa_AxisInformation structure.

Don't manually free the attached structure afterwards, because UaAxisInformation is responsible for it now.

Parameters
pValue[in] Parameter to attach to.
void UaAxisInformation::clear ( )

Clear the data of the UaAxisInformation.

OpcUa_AxisInformation * UaAxisInformation::clone ( const OpcUa_AxisInformation source)
static

Copy OpcUa_AxisInformation data to a newly allocated OpcUa_AxisInformation.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_AxisInformation.
void UaAxisInformation::cloneTo ( const OpcUa_AxisInformation source,
OpcUa_AxisInformation copy 
)
static

Copy OpcUa_AxisInformation data to an existing OpcUa_AxisInformation structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_AxisInformation * UaAxisInformation::copy ( ) const

Copy UaAxisInformation data to a newly allocated OpcUa_AxisInformation.

Returns
pointer to a newly allocated OpcUa_AxisInformation.
void UaAxisInformation::copyTo ( OpcUa_AxisInformation pDst) const

Copy UaAxisInformation data to an existing OpcUa_AxisInformation structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_AxisInformation * UaAxisInformation::detach ( OpcUa_AxisInformation pDst)

Detaches the internal AxisInformation structure from this class.

This way you take over the control of freeing the AxisInformation data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters
pDst[out] Pointer to an OpcUa_AxisInformation structure that receives the AxisInformation data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
void UaAxisInformation::getAxisSteps ( UaDoubleArray axisSteps) const

Specific value of each axis step.

May be set to “Null” if not used.

UaLocalizedText UaAxisInformation::getTitle ( ) const

User readable axis title.

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

bool UaAxisInformation::operator!= ( const UaAxisInformation other) const

Compare two UaAxisInformation for inequality.

See also
operator==
Parameters
otherthe UaAxisInformation to compare with.
Returns
true if not equal, false otherwise.
UaAxisInformation & UaAxisInformation::operator= ( const UaAxisInformation other)

Assignment operator.

Parameters
otherthe UaAxisInformation to assign.
Returns
reference to itself.
bool UaAxisInformation::operator== ( const UaAxisInformation other) const

Compare two UaAxisInformation for equality.

Parameters
otherthe UaAxisInformation to compare with.
Returns
true if equal, false if not.
void UaAxisInformation::setAxisSteps ( const UaDoubleArray axisSteps)

Specific value of each axis step.

May be set to “Null” if not used.

void UaAxisInformation::setTitle ( const UaLocalizedText title)

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 files: