Struct Bool
Represents a rapid data of type bool.
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public struct Bool : IRapidData, IConvertible
Constructors
Bool(Boolean)
Initializes a new instance of the Bool class with a specific value.
Declaration
Parameters
Type |
Name |
Description |
Boolean |
value |
|
Properties
Empty
Gets an empty Bool object.
Declaration
public static readonly Bool Empty { get; }
Property Value
Value
Get/Sets the value of the variable.
Declaration
public bool Value { get; set; }
Property Value
Methods
Fill(DataNode)
Fills the 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 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
FillFromBool(Boolean)
Fills the struct with a bool value.
Declaration
[Obsolete("No longer supported")]
public void FillFromBool(bool newValue)
Parameters
Type |
Name |
Description |
Boolean |
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 Bool object.
Declaration
public static Bool Parse(string value)
Parameters
Type |
Name |
Description |
String |
value |
Value to parse into object.
|
Returns
Type |
Description |
Bool |
The Bool object.
|
ToBoolean()
Thin wrapper around IConvertible.ToBoolean( IFormatProvider ).
Declaration
Returns
Type |
Description |
Boolean |
The Bool value for this object.
|
ToString()
Returns the string representation of the bool rapid data.
Declaration
public override string ToString()
Returns
Type |
Description |
String |
The string representation with the value of the bool 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 Bool)
Attempts to parse the string into object.
Declaration
public static bool TryParse(string value, out Bool result)
Parameters
Type |
Name |
Description |
String |
value |
Value to parse.
|
Bool |
result |
The result of the parse operation.
|
Returns
Type |
Description |
Boolean |
True if parse succeeded.
|
Operators
Implicit(Bool to Boolean)
Converts a Bool struct to a bool.
Declaration
public static implicit operator bool (Bool f)
Parameters
Type |
Name |
Description |
Bool |
f |
A Bool struct reference.
|
Returns
Type |
Description |
Boolean |
The bool value that is stored in the Bool 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