Struct Pos

Represents a rapid data of type pos.

Implements

IRapidData

Namespace: ABB.Robotics.Controllers.RapidDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public struct Pos : IRapidData

Properties

Empty

Creates an empty Pos object.

Declaration

public static readonly Pos Empty { get; }

Property Value

Type	Description
Pos

X

Gets or sets the value of X.

Declaration

public float X { get; set; }

Property Value

Type	Description
System.Single	A float that represents the X value.

Y

Gets or sets the value of Y.

Declaration

public float Y { get; set; }

Property Value

Type	Description
System.Single	A float that represents the Y value.

Z

Gets or sets the value of Z.

Declaration

public float Z { get; set; }

Property Value

Type	Description
System.Single	A float that represents the Z 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 Pos 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 Pos 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 Pos 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 Pos object.

Declaration

public static Pos Parse(string value)

Parameters

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

Returns

Type	Description
Pos	The Pos object.

ToString()

Returns the string representation of the pos rapid data.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation with the value of the pos 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 Pos)

Attempts to parse the string into object.

Declaration

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

Parameters

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

Returns

Type	Description
System.Boolean	True if parse succeeded.

Implements

IRapidData