Struct WobjData

Represents a rapid data of type wobjdata.

Implements

IRapidData

Namespace: ABB.Robotics.Controllers.RapidDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public struct WobjData : IRapidData

Fields

Oframe

Gets or sets the value of Oframe.

Declaration

public Pose Oframe

Field Value

Type	Description
Pose	A Pose that represents the Oframe value.

Uframe

Gets or sets the value of Uframe.

Declaration

public Pose Uframe

Field Value

Type	Description
Pose	A Pose that represents the Uframe value.

Properties

Empty

Gets an empty WobjData object.

Declaration

public static readonly WobjData Empty { get; }

Property Value

Type	Description
WobjData

Robhold

Gets or sets the value of Robhold.

Declaration

public bool Robhold { get; set; }

Property Value

Type	Description
System.Boolean	A bool that represents the Robhold value.

Ufmec

Gets or sets the value of Ufmec.

Declaration

public string Ufmec { get; set; }

Property Value

Type	Description
System.String	A string that represents the Ufmec value.

Ufprog

Gets or sets the value of Ufprog.

Declaration

public bool Ufprog { get; set; }

Property Value

Type	Description
System.Boolean	A bool that represents the Ufprog 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
System.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

Type	Condition
RapidDataFormatException	root does not represent the WobjData data type.

Fill2(String)

Fills the structure with the new value.

Declaration

public void Fill2(string value)

Parameters

Type	Name	Description
System.String	value	Value to fill structure with.

Exceptions

Type	Condition
RapidDataFormatException	value does not represent the WobjData data type.

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
System.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
System.String	newValue	The new value stored by the struct.

Exceptions

Type	Condition
RapidDataFormatException	newValue does not represent the WobjData data type.

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 WobjData object.

Declaration

public static WobjData Parse(string value)

Parameters

Type	Name	Description
System.String	value	Value to parse into object.

Returns

Type	Description
WobjData	The WobjData object.

ToString()

Returns the string representation of the wobjdata rapid data.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation with the value of the wobjdata rapid data.

Overrides

System.ValueType.ToString()

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 WobjData)

Attempts to parse the string into object.

Declaration

public static bool TryParse(string value, out WobjData result)

Parameters

Type	Name	Description
System.String	value	Value to parse.
WobjData	result	The result of the parse operation.

Returns

Type	Description
System.Boolean	True if parse succeeded.

Implements

IRapidData