DIATwinAPI Namespace Reference

Classes
class	ErrorCode
	The ErrorCode list and description. More...
class	DT_CommandType
	List of statement types. More...
class	ControllerType
	Type of robot controller. More...
class	ImportHint
	Type of import component. More...
class	SimulationAction
class	Component
class	Robot
class	FileHandler

Functions
	decodeFeedbackData (packet_bytes)
	Decode the feedback data from socket.
	recv_all (sock, length)
	recv_packet (sock)
	connect ()
	Initialization API and connection.
	IsBusy ()
	Determine if the system is busy.
	getRobotList ()
	Retrieve the list of all current robotic arms.s.
	getComponentList ()
	Retrieve the list of all current component.
	setSlotInterface (parentSlot, childSlot)
	Link the specified slot parent and slot child.
	unsetSlotInterface (parentSlot)
	Disconnect the specified slot parent.
	getCoordinateSystem (uuid)
	Get the component coordinate.
	simulationRun ()
	Run simulation in DIATwin.
	simulationReset ()
	Reset simulation in DIATwin.
	getSimulationStatus ()
	Get simulation status in DIATwin.
	getIOTable ()
	Get IO map list.
	disconnect ()
	Disconnect the connection.

Function Documentation

connect()

DIATwinAPI.connect

(

)

Initialization API and connection.

Returns

Return whether the connection was successful.

decodeFeedbackData()

DIATwinAPI.decodeFeedbackData

(

packet_bytes

)

Decode the feedback data from socket.

Parameters

data	the data from socket.

Returns

Result of the Errcode, data and message.

Here is the caller graph for this function:

disconnect()

DIATwinAPI.disconnect

(

)

Disconnect the connection.

getComponentList()

DIATwinAPI.getComponentList

(

)

Retrieve the list of all current component.

Returns

Return error code along with the list of component.

Here is the call graph for this function:

getCoordinateSystem()

DIATwinAPI.getCoordinateSystem

(

uuid

)

Get the component coordinate.

Parameters

component

The component to take coordinates.

Returns

Return error code and message.

getIOTable()

DIATwinAPI.getIOTable

(

)

Get IO map list.

Returns

Return error code and IO map.

Here is the call graph for this function:

getRobotList()

DIATwinAPI.getRobotList

(

)

Retrieve the list of all current robotic arms.s.

Returns

Return error code along with the list of robotic arms.

Here is the call graph for this function:

getSimulationStatus()

DIATwinAPI.getSimulationStatus

(

)

Get simulation status in DIATwin.

Returns

Return error code and message.

Here is the call graph for this function:

IsBusy()

DIATwinAPI.IsBusy

(

)

Determine if the system is busy.

Returns

Return whether the system is busy.

Here is the call graph for this function:

recv_all()

DIATwinAPI.recv_all	(		sock,
			length )

Here is the caller graph for this function:

recv_packet()

DIATwinAPI.recv_packet

(

sock

)

Here is the call graph for this function:

Here is the caller graph for this function:

setSlotInterface()

DIATwinAPI.setSlotInterface	(		parentSlot,
			childSlot )

Link the specified slot parent and slot child.

Parameters

parentSlot	The specified slot parent.
childSlot	The specified slot child.

Returns

Return error code and message.

Here is the call graph for this function:

simulationReset()

DIATwinAPI.simulationReset

(

)

Reset simulation in DIATwin.

Returns

Return error code and message.

Here is the call graph for this function:

simulationRun()

DIATwinAPI.simulationRun

(

)

Run simulation in DIATwin.

Returns

Return error code and message.

Here is the call graph for this function:

unsetSlotInterface()

DIATwinAPI.unsetSlotInterface

(

parentSlot

)

Disconnect the specified slot parent.

Parameters

parentSlot

The specified slot parent.

Returns

Return error code and message.

Here is the call graph for this function: