Struct Num
Represents a rapid data of type num.
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public struct Num : IRapidData, IConvertible
Constructors
Num(Double)
Initializes a new instance of the Num class with a specific value.
Declaration
Parameters
Type |
Name |
Description |
Double |
value |
|
Properties
Empty
Declaration
public static readonly Num Empty { get; }
Property Value
Type |
Description |
Num |
The empty instance.
|
Value
Gets/Sets the value of the object.
Declaration
public double Value { get; set; }
Property Value
Methods
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.
|
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.
|
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
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
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.
|
FillFromString(String)
Declaration
[Obsolete("Use FillFromString2 instead.")]
public void FillFromString(string newValue)
Parameters
Type |
Name |
Description |
String |
newValue |
The new value stored by the struct.
|
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
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.
|
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.
|
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
ToStructure()
Converts the datastructure into a DataNode tree.
Declaration
public DataNode ToStructure()
Returns
Type |
Description |
DataNode |
The root of the corresponding data tree.
|
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 |
Boolean |
True if parse succeeded.
|
Operators
Implicit(Num to Double)
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
|
Explicit Interface Implementations
IConvertible.GetTypeCode()
Declaration
TypeCode IConvertible.GetTypeCode()
Returns
IConvertible.ToBoolean(IFormatProvider)
Declaration
bool IConvertible.ToBoolean(IFormatProvider provider)
Parameters
Returns
IConvertible.ToByte(IFormatProvider)
Declaration
byte IConvertible.ToByte(IFormatProvider provider)
Parameters
Returns
IConvertible.ToChar(IFormatProvider)
Declaration
char IConvertible.ToChar(IFormatProvider provider)
Parameters
Returns
IConvertible.ToDateTime(IFormatProvider)
Declaration
DateTime IConvertible.ToDateTime(IFormatProvider provider)
Parameters
Returns
IConvertible.ToDecimal(IFormatProvider)
Declaration
decimal IConvertible.ToDecimal(IFormatProvider provider)
Parameters
Returns
IConvertible.ToDouble(IFormatProvider)
Declaration
double IConvertible.ToDouble(IFormatProvider provider)
Parameters
Returns
IConvertible.ToInt16(IFormatProvider)
Declaration
short IConvertible.ToInt16(IFormatProvider provider)
Parameters
Returns
IConvertible.ToInt32(IFormatProvider)
Declaration
int IConvertible.ToInt32(IFormatProvider provider)
Parameters
Returns
IConvertible.ToInt64(IFormatProvider)
Declaration
long IConvertible.ToInt64(IFormatProvider provider)
Parameters
Returns
IConvertible.ToSByte(IFormatProvider)
Declaration
sbyte IConvertible.ToSByte(IFormatProvider provider)
Parameters
Returns
IConvertible.ToSingle(IFormatProvider)
Declaration
float IConvertible.ToSingle(IFormatProvider provider)
Parameters
Returns
IConvertible.ToString(IFormatProvider)
Declaration
string IConvertible.ToString(IFormatProvider provider)
Parameters
Returns
IConvertible.ToType(Type, IFormatProvider)
Declaration
object IConvertible.ToType(Type conversionType, IFormatProvider provider)
Parameters
Returns
IConvertible.ToUInt16(IFormatProvider)
Declaration
ushort IConvertible.ToUInt16(IFormatProvider provider)
Parameters
Returns
IConvertible.ToUInt32(IFormatProvider)
Declaration
uint IConvertible.ToUInt32(IFormatProvider provider)
Parameters
Returns
IConvertible.ToUInt64(IFormatProvider)
Declaration
ulong IConvertible.ToUInt64(IFormatProvider provider)
Parameters
Returns
Implements