Struct Bool

Represents a rapid data of type bool.

Implements

Namespace: ABB.Robotics.Controllers.RapidDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public struct Bool : IRapidData, IConvertible

Constructors

View Source

Bool(bool)

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

Declaration

public Bool(bool value)

Parameters

Type	Name	Description
bool	value

Properties

View Source

Empty

Gets an empty Bool object.

Declaration

public static Bool Empty { get; }

Property Value

Type	Description
Bool

View Source

Value

Get/Sets the value of the variable.

Declaration

public bool Value { get; set; }

Property Value

Type	Description
bool

Methods

View Source

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.

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 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 Bool 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 Bool data type.

View Source

FillFromBool(bool)

Fills the struct with a bool value.

Declaration

[Obsolete("No longer supported")]
public void FillFromBool(bool newValue)

Parameters

Type	Name	Description
bool	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 Bool 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 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.

View Source

ToBoolean()

Thin wrapper around IConvertible.ToBoolean( IFormatProvider ).

Declaration

public bool ToBoolean()

Returns

Type	Description
bool	The Bool value for this object.

View Source

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

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 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
bool	True if parse succeeded.

Operators

View Source

implicit operator bool(Bool)

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
bool	The bool value that is stored in the Bool struct

Implements

IRapidData

IConvertible