Skip to Content
FASTSUITE E2API ReferencePython APIAPI DomainsDownloadDownload Position

Download Position

Quick Facts

PropertyValue
ClassDULPythonPosition
Modulecenpydownload.DULPythonPosition
Packagecenpydownload
ReleaseR2025.2.4
Methods9
Inherits fromOlpCorePythonProgramComponent
SubclassesUpload Position

Inheritance

Quick Start

# Boilerplate Example downloadPosition = ... # obtained from the runtime context result = downloadPosition.GetXYZ()

Method Index

MethodReturnsSummary
GetXYZtupleGets position
GetOrientationtupleGets orientation
GetConfigstrGets position config
GetTurnstrGets turn value
GetAllJointValueslist[DULPythonJoint]Gets the vector of all joints and joint values
GetMainJointValueslist[DULPythonJoint]Gets the vector of main joints and joint values
GetExternalJointValueslist[DULPythonJoint]Gets the vector of external joints and joint values
GetProcessTypeProcessTypeGets process type
GetTargetTypeTargetTypeGets target type

Query Methods

GetXYZ

def GetXYZ() -> tuple

Gets position

Returns: tuple — tuple of double containing position values

GetOrientation

def GetOrientation() -> tuple

Gets orientation

Returns: tuple — tuple of double containing rotation angles values

GetConfig

def GetConfig() -> str

Gets position config

Returns: str — config string

GetTurn

def GetTurn() -> str

Gets turn value

Returns: str — turn value string

GetAllJointValues

def GetAllJointValues() -> list[DULPythonJoint]

Gets the vector of all joints and joint values

Returns: list[DULPythonJoint] — returns list[tuple[DULPythonJoint, float]] for all joint values

GetMainJointValues

def GetMainJointValues() -> list[DULPythonJoint]

Gets the vector of main joints and joint values

Returns: list[DULPythonJoint] — returns list[tuple[DULPythonJoint, float]] for main joint values

GetExternalJointValues

def GetExternalJointValues() -> list[DULPythonJoint]

Gets the vector of external joints and joint values

Returns: list[DULPythonJoint] — returns list[tuple[DULPythonJoint, float]] for external joint values

GetProcessType

def GetProcessType() -> ProcessType

Gets process type

Returns: ProcessType — process type

GetTargetType

def GetTargetType() -> TargetType

Gets target type

Returns: TargetType — target type

Version Notes

This class is documented as of release R2025.2.4.

Was this page helpful?