ParameterCollection Class Reference

This class describes a parameter collection. More...

Inherits PacketItem.

Public Member Functions
Initialize / Finalize
Functions handling class initialization and finalization.
def	ParameterCollection ( Optional[ParameterCollection] param_collection=None -> def ) -> def
	Class initializer. More...
def	clone ( -> ParameterCollection ) -> def
	Creates a new instance of the object with the same contents.
def	copy (copy_from: object -> None ) -> def
	Copies the contents of the provided 'copy_from' ParameterCollection. More...
def	initialize ( -> None ) -> def
	Initializes the object. More...
def	load_file (filename: str -> None ) -> def
	Loads the ParameterCollection definition from the specified file. More...
def	save_file (filename: str -> None ) -> def
	Saves the ParameterCollection definition to the specified file. More...
Build and Extract
def	build (buffer: bytearray -> int ) -> def
	Builds the parameter collection and places it in the specified buffer. More...
def	extract (buffer: bytearray, input_length: int, start_bit: int -> int ) -> def
	Extracts all of the parameters in the collection from the specified buffer. More...
def	get_length_in_bits ( -> int ) -> def
	Gets the length of the parameter collection in bits. More...
def	get_length_in_bytes ( -> int ) -> def
	Gets the length of the parameter collection in bytes. More...
def	get_maximum_length_in_bits ( -> int ) -> def
	Returns the maximum length of the ParameterCollection in bits. More...
def	has_modifiable_data (data_zone_only: bool=True -> bool ) -> def
	Determines if any parameter in the collection is modifiable. More...
def	has_variable_length_data ( -> bool ) -> def
	Determines if the parameter collection has any variable length data. More...
def	is_complete ( -> bool ) -> def
	Determines if all parameters have a value. More...
def	is_modifiable (top_level: bool=True -> bool ) -> def
	Determines if any data is modifiable. More...
Parameters
Functions handling parameters.
def	add_parameter (parameter: Parameter -> None ) -> def
	Adds the parameter to the collection. More...
def	find_parameter (name: str -> Parameter ) -> def
	Finds the specified parameter in the collection. More...
def	get_next_parameter ( -> Optional[Parameter] ) -> def
	Finds the specified parameter in the collection. More...
def	get_number_of_parameters ( -> int ) -> def
	Returns the number of parameters in the collection. More...
def	get_parameter_list (full_name: bool=True, mod_only: bool=False -> list[str] ) -> def
	Returns a list of all parameters within a collection. More...
def	get_sorted_parameter_list (full_name: bool=True, mod_only: bool=False -> list[str] ) -> def
	Returns a sorted list of all parameters within a collection by their start location. More...
def	remove_parameter (name: str -> None ) -> def
	Removes a parameter from the collection. More...
def	remove_all_parameters ( -> None ) -> def
	Removes all parameters and associated memory from the collection.
def	set_start ( -> None ) -> def
	Resets the start location to the first. More...
Parameters
Functions handling Parameters.
Packet
Functions handling Packets.
Public Member Functions inherited from NamedItem
def	remove_all_attributes ( -> None ) -> def
	Removes all attributes.
def	remove_attribute (name: str -> None ) -> def
	Removes the attribute by name. More...
def	__eq__ (named_item: object -> bool ) -> def
	Equality operator "==". More...
def	add_attribute (name: str, value: str -> None ) -> def
	Adds an attribute to the item. More...
def	get_alias ( -> str ) -> def
	Returns the alias of the item. More...
def	get_attribute (name: str -> str ) -> def
	Get the value of the specified attribute. More...
def	get_attribute_list ( -> list[str] ) -> def
	Gets a list of the attribute names. More...
def	get_name ( -> str ) -> def
	Returns the name of the item. More...
def	get_long_description ( -> str ) -> def
	Returns the long description of the item. More...
def	get_short_description ( -> str ) -> def
	Returns the short description of the item. More...
def	get_user_description ( -> str ) -> def
	Returns the user description of the item. More...
def	get_owner ( -> str ) -> def
	Returns the owner of the item. More...
def	get_path ( -> str ) -> def
	Returns the path for the item. More...
def	set_name (name: str -> None ) -> def
	Sets the name of the item. More...
def	set_alias (alias: str -> None ) -> def
	Sets the alias of the item. More...
def	set_short_description (description: str -> None ) -> def
	Sets the short description of the item. More...
def	set_long_description (description: str -> None ) -> def
	Sets the long description of the item. More...
def	set_user_description (description: str -> None ) -> def
	Sets the user description of the item. More...
def	set_owner (owner: str -> None ) -> def
	Sets the owner of the item. More...
def	set_path (path: str -> None ) -> def
	Sets the path of the item. More...

Detailed Description

This class describes a parameter collection.

ParameterCollection holds parameters that can be built and placed in a packet.

Constructor & Destructor Documentation

ParameterCollection()

(

param_collection

: Optional[ParameterCollection]

)

-> def

Class initializer.

Parameters

[in]

param_collection

(Optional) ParameterCollection to copy.

Reimplemented from NamedItem.

Member Function Documentation

add_parameter()

(

parameter

: Parameter

)

-> None

Adds the parameter to the collection.

Adds the parameter to the parameter collection with the indexed by the name of the parameter. The ParameterCollection makes a copy of the input.

Parameters

[in]

parameter

The parameter to add.

Exceptions

TrekError

15005 - TREK_DATA_ALREADY_EXISTS

build()

(

buffer

: bytearray

)

-> int

Builds the parameter collection and places it in the specified buffer.

The parameters composing the collection are built and placed in the buffer.

Returns

The last bit used if successful.

Exceptions

TrekError

15021 - TREK_DATA_WILL_NOT_FIT

copy()

(

copy_from

: object

)

-> None

Copies the contents of the provided 'copy_from' ParameterCollection.

Parameters

[in]

copy_from

ParameterCollection to copy from.

Exceptions

TypeError

if 'copy_from' is not a ParameterCollection.

Reimplemented from NamedItem.

extract()

(	buffer	: bytearray
		input_length	: int
		start_bit	: int
		)	-> int

Extracts all of the parameters in the collection from the specified buffer.

Loops through all of the parameters contained in the collection and extracts their indiviual values (see Parameter for details on what parameter extraction encompasses).

Parameters

buffer	The buffer from which to extract.
input_length	The valid number of bits that can be read.
start_bit	The starting bit in the buffer to begin reading.

Returns

The last bit used, if successful.

Exceptions

TrekError

15062 - TREK_LAST_BIT_ERROR

find_parameter()

(

name

: str

)

-> Parameter

Finds the specified parameter in the collection.

Parameters

[in]

name

The name of the parameter to fine.

Returns

A parameter reference from the collection.

Exceptions

TrekError

15007 - TREK_DATA_DOES_NOT_EXIST

Reimplemented from PacketItem.

get_length_in_bits()

(

)

-> int

Gets the length of the parameter collection in bits.

Calculates the length of the parameter collection in bits by determining the last bit used by any parameter in the packet. If the parameter collection contains a variable length parameter, this method will fail.

Returns

Length in bits.

Exceptions

TrekError

15017 - TREK_DATA_FIXED_LENGTH_REQUIRED

Reimplemented from PacketItem.

get_length_in_bytes()

(

)

-> int

Gets the length of the parameter collection in bytes.

Calculates the length of the parameter collection in bytes by determining the last bit used by any parameter in the packet. If the parameter collection contains a variable length parameter, this method will fail.

Returns

Length in bytes.

Exceptions

TrekError

15017 - TREK_DATA_FIXED_LENGTH_REQUIRED

Reimplemented from PacketItem.

get_maximum_length_in_bits()

(

)

-> int

Returns the maximum length of the ParameterCollection in bits.

If the ParameterCollection has variable length data, the actual length may be less than the returned value.

Returns

Maximum length in bits.

Reimplemented from PacketItem.

get_next_parameter()

(

)

-> Optional[Parameter]

Finds the specified parameter in the collection.

Returns

A parameter reference from the collection.

None if end of data.

get_number_of_parameters()

(

)

-> int

Returns the number of parameters in the collection.

Returns

Number of parameters.

get_parameter_list()

(	full_name	: bool
		mod_only	: bool
		)	-> list[str]

Returns a list of all parameters within a collection.

Parameters

[in]	full_name	True, indicates to return parameter fully qualified names.
[in]	mod_only	Indicates if the returned data should be limited to modifiable parameters.

Returns

list[str] containing of all parameters within a collection.

Reimplemented from PacketItem.

get_sorted_parameter_list()

(	full_name	: bool
		mod_only	: bool
		)	-> list[str]

Returns a sorted list of all parameters within a collection by their start location.

Parameters

[in]	full_name	True, indicates to return parameter fully qualified names.
[in]	mod_only	Indicates if the returned data should be limited to modifiable parameters.

Returns

list[str] containing of all parameters sorted by start location.

Reimplemented from PacketItem.

has_modifiable_data()

(

data_zone_only

: bool

)

-> bool

Determines if any parameter in the collection is modifiable.

Returns

True, if at least one is modifiable.

Reimplemented from PacketItem.

has_variable_length_data()

(

)

-> bool

Determines if the parameter collection has any variable length data.

Returns

True, if parameter has any variable length data.

Reimplemented from PacketItem.

initialize()

(

)

-> None

Initializes the object.

Clears any set values in the ParameterCollection. New instances do not need to be initialized.

Reimplemented from NamedItem.

is_complete()

(

)

-> bool

Determines if all parameters have a value.

Returns

If all parameters have a value.

Reimplemented from PacketItem.

is_modifiable()

(

top_level

: bool

)

-> bool

Determines if any data is modifiable.

Parameters

[in]

top_level

Designates that this is a top level packet.

Returns

True, if at least one is modifiable.

Reimplemented from PacketItem.

load_file()

(

filename

: str

)

-> None

Loads the ParameterCollection definition from the specified file.

Reads an XML ParameterCollection.

Parameters

[in]

filename

The file from which to load the ParameterCollection object.

remove_parameter()

(

name

: str

)

-> None

Removes a parameter from the collection.

Parameters

[in]

name

The name of the parameter to remove.

Exceptions

TrekError

15007 - TREK_DATA_DOES_NOT_EXIST

save_file()

(

filename

: str

)

-> None

Saves the ParameterCollection definition to the specified file.

Writes an XML ParameterCollection.

Parameters

[in]

filename

The file to save the parameter collection object.

set_start()

(

)

-> None

Resets the start location to the first.

Use in conjunctions with get_next_parameter() to cycle through all of the parameters contained in the collection.