TrackItem Class Reference

This class holds all of the responses associated with a single command uplink. More...

Public Member Functions
Initialize / Finalize
Functions handling class initialization and finalization.
def	TrackItem ( Optional[c_void_p] native_ptr=None -> None ) -> def
	Default constructor. More...
TrackItem Properties
Functions handling TrackItem properties.
def	get_command_name ( -> str ) -> def
	Returns the command name associated with the uplink. More...
def	get_token ( -> int ) -> def
	Returns the token associated with the command uplink.
def	get_uplink_time (time: TrekTime -> None ) -> def
	Returns the time associated with the command uplink. More...
def	set_command_name (name: str -> None ) -> def
	Set the command name. More...
def	set_token (token: int -> None ) -> def
	Set the current token. More...
Responses
Functions handling responses.
def	get_number_of_responses ( -> int ) -> def
	Returns the number of responses available. More...
def	get_response (index: int -> ResponseItem ) -> def
	Gets the information about the specified response. More...

Detailed Description

This class holds all of the responses associated with a single command uplink.

Only methods that are expected to be used by user applications are documented.

Constructor & Destructor Documentation

TrackItem()

(

native_ptr

: Optional[c_void_p]

)

-> None

Default constructor.

Parameters

[in]

native_ptr

(Optional) Internal parameter, do not provide.

Member Function Documentation

get_command_name()

(

)

-> str

Returns the command name associated with the uplink.

Returns

Command name associated with uplink or None if it does not exist.

get_number_of_responses()

(

)

-> int

Returns the number of responses available.

Returns

Number of responses available.

get_response()

(

index

: int

)

-> ResponseItem

Gets the information about the specified response.

Throws exception if attempting retrieve a response outside array bounds.

Parameters

[in]

index

Index into an array of responses [0 <= get_number_of_responses()]

Exceptions

TrekError

11004 - CMD_API_DOES_NOT_EXIST

get_uplink_time()

(

time

: TrekTime

)

-> None

Returns the time associated with the command uplink.

Parameters

[in,out]

time

TrekTime class to place the time.

set_command_name()

(

name

: str

)

-> None

Set the command name.

Note

TReK Internal.

Parameters

[in]

name

Command name.

set_token()

(

token

: int

)

-> None

Set the current token.

Note

TReK Internal.

Parameters

[in]

token

Token value.