Struct Num

Represents a rapid data of type num.

Implements
Namespace: ABB.Robotics.Controllers.RapidDomain
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public struct Num : IRapidData, IConvertible

Constructors

View Source

Num(double)

Initializes a new instance of the Num class with a specific value.

Declaration
public Num(double value)
Parameters
Type Name Description
double value

Properties

View Source

Empty

Gets an empty instance.

Declaration
public static Num Empty { get; }
Property Value
Type Description
Num

The empty instance.
View Source

Value

Gets/Sets the value of the object.

Declaration
public double Value { get; set; }
Property Value
Type Description
double

Methods

View Source

Fill(DataNode)

Fills the RapidData object from the specified parser root. This is Obsolete, use Fill2(DataNode) instead.

Declaration
[Obsolete("Use Fill2(DataNode) instead.")]
public void Fill(DataNode root)
Parameters
Type Name Description
DataNode root

Root of data.
View Source

Fill(string)

Fills the structure with the new value. This is Obsolete, use Fill2(string) instead.

Declaration
[Obsolete("Use Fill2(string) instead.")]
public void Fill(string value)
Parameters
Type Name Description
string value

Value to fill structure with.
View Source

Fill2(DataNode)

Fills the RapidData object from the specified parser root.

Declaration
public void Fill2(DataNode root)
Parameters
Type Name Description
DataNode root

Root of data.
Exceptions
Type Condition
RapidDataFormatException

root does not represent the Num data type.
View Source

Fill2(string)

Fills the structure with the new value.

Declaration
public void Fill2(string value)
Parameters
Type Name Description
string value

Value to fill structure with.
Exceptions
Type Condition
RapidDataFormatException

value does not represent the Num data type.
View Source

FillFromNum(double)

Fills the struct with a double value.

Declaration
[Obsolete("No longer supported")]
public void FillFromNum(double newValue)
Parameters
Type Name Description
double newValue

The new value stored by the struct.
View Source

FillFromString(string)

Fills the struct with a valid rapid string representation. This is Obsolete, use FillFromString2(string) instead.

Declaration
[Obsolete("Use FillFromString2 instead.")]
public void FillFromString(string newValue)
Parameters
Type Name Description
string newValue

The new value stored by the struct.
View Source

FillFromString2(string)

Fills the struct with a valid rapid string representation.

Declaration
public void FillFromString2(string newValue)
Parameters
Type Name Description
string newValue

The new value stored by the struct.
Exceptions
Type Condition
RapidDataFormatException

newValue does not represent the Num data type.
View Source

GetDataType(Controller)

Gets the datatype object for this type from the supplied controller.

Declaration
public static RapidDataType GetDataType(Controller controller)
Parameters
Type Name Description
Controller controller

Controller containing the datatype.
Returns
Type Description
RapidDataType

A valid datatype object if it exist on the controller.
View Source

Parse(string)

Parses the string into a Num object.

Declaration
public static Num Parse(string value)
Parameters
Type Name Description
string value

Value to parse into object.
Returns
Type Description
Num

The Num object.
View Source

ToString()

Returns the string representation of the num rapid data.

Declaration
public override string ToString()
Returns
Type Description
string

The string representation with the value of the num rapid data.
Overrides
System.ValueType.ToString()
View Source

ToStructure()

Converts the datastructure into a DataNode tree.

Declaration
public DataNode ToStructure()
Returns
Type Description
DataNode

The root of the corresponding data tree.
View Source

TryParse(string, out Num)

Attempts to parse the string into object.

Declaration
public static bool TryParse(string value, out Num result)
Parameters
Type Name Description
string value

Value to parse.
Num result

The result of the parse operation.
Returns
Type Description
bool

True if parse succeeded.

Operators

View Source

implicit operator double(Num)

Converts a Num struct to a double.

Declaration
public static implicit operator double(Num f)
Parameters
Type Name Description
Num f

A Num struct reference.
Returns
Type Description
double

The double value that is stored in the Num struct

Implements