UnifiedAutomation.UaBase.Argument Class Reference

Defines a method input or output argument specification. More...

Inherits IFormattable, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions
	Argument ()
	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 ()
override string	ToString ()
	Returns a System.String that represents this instance. More...
string	ToString (string format, IFormatProvider formatProvider)
	Returns a System.String that represents this instance. More...

Properties
string	Name [get, set]
	The name of the argument More...
NodeId	DataType [get, set]
	The NodeId of the DataType of this argument. More...
int	ValueRank [get, set]
	Indicates whether the DataType is an array and how many dimensions the array has. More...
UInt32Collection	ArrayDimensions [get, set]
	Specifies the length of each dimension for an array dataType. More...
LocalizedText	Description [get, set]
	A localised description of the argument. More...
virtual ExpandedNodeId	TypeId [get]
virtual ExpandedNodeId	BinaryEncodingId [get]
virtual ExpandedNodeId	XmlEncodingId [get]
Variant	Value [get, set]
	Gets or sets the value. More...
object	UserData [get, set]
	Gets or sets the user data. More...
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 a method input or output argument specification.

It is for example used in the input and output argument Properties for methods.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.Argument.Argument ( )

inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.Argument.IsEqual ( IEncodeable  encodeable )

inlinevirtual

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

Parameters

encodeable

Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

override string UnifiedAutomation.UaBase.Argument.ToString ( )

inline

Returns a System.String that represents this instance.

Returns

A System.String that represents this instance.

string UnifiedAutomation.UaBase.Argument.ToString ( string  format, IFormatProvider  formatProvider  )

inline

Returns a System.String that represents this instance.

Parameters

format	The format.
formatProvider	The format provider.

Returns

A System.String that represents this instance.

Property Documentation

UInt32Collection UnifiedAutomation.UaBase.Argument.ArrayDimensions

getset

Specifies the length of each dimension for an array dataType.

It is intended to describe the capability of the DataType, not the current size.

The number of elements shall be equal to the value of the valueRank. Shall be null if valueRank ≦ 0.

A value of 0 for an individual dimension indicates that the dimension has a variable length.

NodeId UnifiedAutomation.UaBase.Argument.DataType

getset

The NodeId of the DataType of this argument.

LocalizedText UnifiedAutomation.UaBase.Argument.Description

getset

A localised description of the argument.

string UnifiedAutomation.UaBase.Argument.Name

getset

The name of the argument

object UnifiedAutomation.UaBase.Argument.UserData

getset

Gets or sets the user data.

The user data.

Variant UnifiedAutomation.UaBase.Argument.Value

getset

Gets or sets the value.

The value.

int UnifiedAutomation.UaBase.Argument.ValueRank

getset

Indicates whether the DataType is an array and how many dimensions the array has.

It may have the following values:

n> 1

The DataType is an array with the specified number of dimensions.

OneDimension (1)

The DataType is an array with one dimension.

OneOrMoreDimensions (0)

The dataType is an array with one or more dimensions.

Scalar (−1)

The DataType is not an array.

Any (−2)

The DataType can be a scalar or an array with any number of dimensions.

ScalarOrOneDimension (−3)

The DataType can be a scalar or a one dimensional array.

Note

All DataTypes are considered to be scalar, even if they have array-like semantics like ByteString and String.

---

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

• C:/work/uasdknet/src/UaBase/Generated/Opc.Ua.DataTypes.cs
• C:/work/uasdknet/src/UaBase/Helpers/Argument.cs