UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
JsonMng.JsonComm Class Reference

Public Member Functions

 __init__ (self, comm_to_ptr, comm_type)
 Initializes a new instance with the given communication pointer and type.
 
 get_ptr_comm (self)
 Gets the TCP communication instance.
 
 set_using_data_port (self, using_data_port)
 Set to True if you use USB Comm.
 
 start (self)
 
 stop (self)
 Stop the JSON communication.
 
 stop_ex (self)
 Extended stop function for the JSON communication.
 

Public Attributes

 using_data_port
 
 m_th_is_running
 

Constructor & Destructor Documentation

◆ __init__()

JsonMng.JsonComm.__init__ ( self,
comm_to_ptr,
comm_type )

Initializes a new instance with the given communication pointer and type.

Parameters
comm_to_ptrThe pointer to the communication instance.
comm_typeThe type of communication.
Returns
An initialized instance of JsonComm, or nil if the object could not be created.

Member Function Documentation

◆ get_ptr_comm()

JsonMng.JsonComm.get_ptr_comm ( self)

Gets the TCP communication instance.

Returns
A pointer to the TcpComm instance.

◆ set_using_data_port()

JsonMng.JsonComm.set_using_data_port ( self,
using_data_port )

Set to True if you use USB Comm.

Parameters
using_data_portTrue if use USBComm else False.

◆ start()

JsonMng.JsonComm.start ( self)
@~English
@brief Starts the JSON communication.

@~Chinese
@brief 启动 JSON 通信。

@~Chinese-Traditional
@brief 啟動 JSON 通信。

◆ stop()

JsonMng.JsonComm.stop ( self)

Stop the JSON communication.

◆ stop_ex()

JsonMng.JsonComm.stop_ex ( self)

Extended stop function for the JSON communication.

Member Data Documentation

◆ m_th_is_running

JsonMng.JsonComm.m_th_is_running

◆ using_data_port

JsonMng.JsonComm.using_data_port

The documentation for this class was generated from the following file: