CommandTrack Class Reference

Contains one or more track items for command uplink history. More...

Public Member Functions
Initialize / Finalize
Functions handling class initialization and finalization.
def	CommandTrack ( -> def ) -> def
	Class initializer.
def	copy (copy_from: object -> None ) -> def
	Copies the contents of the provided 'copy_from' CommandTrack. More...
TrackItems
Functions handling TrackItems.
def	find (token: int -> Optional[TrackItem] ) -> def
	Gets the track item for the specified token. More...
def	get_all_track_items ( -> TrackItemArray ) -> def
	Gets all of the track items.
def	remove_all_items_from_map ( -> None ) -> def
	Removes all items from the internal track map.
def	update_command_track (command_track: CommandTrack -> None ) -> def
	Updates the track with each track item in the input. More...
def	update_track_item (track_item: TrackItem -> None ) -> def
	Updates the specficied track item. More...

Detailed Description

Contains one or more track items for command uplink history.

Member Function Documentation

copy()

(

copy_from

: object

)

-> None

Copies the contents of the provided 'copy_from' CommandTrack.

Parameters

[in]

copy_from

CommandTrack to copy from.

Exceptions

TypeError

if 'copy_from' is not a CommandTrack.

find()

(

token

: int

)

-> Optional[TrackItem]

Gets the track item for the specified token.

Parameters

[in]

token

The token item to find (>=0).

Returns

TrackItem if located.

None if not located.

Exceptions

TypeError	if token < 0.
TrekError	CMD_API_DOES_NOT_EXIST

update_command_track()

(

command_track

: CommandTrack

)

-> None

Updates the track with each track item in the input.

Parameters

[in]

command_track

The items to update.

update_track_item()

(

track_item

: TrackItem

)

-> None

Updates the specficied track item.

If the track item already exists, this method will update its contents with the contents of item_ptr. If the track item does not exist, it is added to the map.

Parameters

[in]

track_item

The new item contents.