BaseEnumerator Class Reference

Abstract Base Class for Enumerators. More...

Inherits NamedItem.

Inherited by Enumerator, RangeEnumerator, and SignedEnumerator.

Public Member Functions
Initialize / Finalize
Functions handling class initialization and finalization.
def	clone ( -> object ) -> def
	Creates a new instance of the object with the same contents. More...
Enumeration Values
Functions handling enumeration names and values.
def	add_enum (int_value: int, str_value: str, end_value: int=0 -> None ) -> def
	Adds the string values as enumeration for the unsigned integer value. More...
def	get_enum_name (enum_value: int -> str ) -> def
	Finds the corresponding string value for the specified unsigned integer. More...
def	get_enum_names ( -> List[str] ) -> def
	Gets a list of the string enumerations. More...
def	get_enum_ranges ( -> List[EnumeratorRangePoint] ) -> def
	Gets a list of the begin and end values for which enumerators exist. More...
def	get_enum_value (enum_name: str -> int ) -> def
	Finds the corresponding unsigned integer value for the specified string. More...
def	get_enum_values ( -> List[int] ) -> def
	Gets a list of the integer values. More...
def	get_number_of_enumerations ( -> int ) -> def
	Returns the current number of enumerations. More...
def	remove_enum_all ( -> None ) -> def
	Remove all enumerations. More...
def	remove_enum_name (enum_name: str -> None ) -> def
	Removes the enumeration specifed by the string. More...
def	remove_enum_value (enum_value: int -> None ) -> def
	Removes the enumeration specifed by the integer. More...
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	BaseEnumerator ( Optional[NamedItem] named_item=None -> None ) -> def
	Class initializer. More...
def	__eq__ (named_item: object -> bool ) -> def
	Equality operator "==". More...
def	copy (copy_from: object -> None ) -> def
	Copies the contents of the provided 'copy_from' NamedItem into this NamedItem. More...
def	initialize ( -> None ) -> def
	Initializes the object. 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

Abstract Base Class for Enumerators.

See also

enumerator.Enumerator

rangeenumerator.RangeEnumerator

Member Function Documentation

add_enum()

(	int_value	: int
		str_value	: str
		end_value	: int
		)	-> None

Adds the string values as enumeration for the unsigned integer value.

The range enumerator matches if the value is greater than or equal to the begin value and less than or equal to the end value.

Parameters

[in]	int_value	The integer value.
[in]	str_value	The string value.
[in]	end_value	The end value for the enumerator must be >= int_value (begin). Default (0).

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

clone()

(

)

-> object

Creates a new instance of the object with the same contents.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

get_enum_name()

(

enum_value

: int

)

-> str

Finds the corresponding string value for the specified unsigned integer.

Parameters

[in]

enum_value

The enum_value to for which to provide the name.

Returns

The enum name for the provided value.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

get_enum_names()

(

)

-> List[str]

Gets a list of the string enumerations.

Returns

list[str] of the enumeration strings.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

get_enum_ranges()

(

)

-> List[EnumeratorRangePoint]

Gets a list of the begin and end values for which enumerators exist.

For Enumerator, the begin and end values will always be the same.

Returns

list[EnumeratorRangePoint] containing begin, end values.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

get_enum_value()

(

enum_name

: str

)

-> int

Finds the corresponding unsigned integer value for the specified string.

This function will return the 'begin' for the range.

Parameters

[in]

enum_name

Enumeration for which to find a value.

Exceptions

TrekError

15007 - TREK_DATA_DOES_NOT_EXIST

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

get_enum_values()

(

)

-> List[int]

Gets a list of the integer values.

Returns

list[int] of the integer values.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

get_number_of_enumerations()

(

)

-> int

Returns the current number of enumerations.

Returns

Number of enumerations.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

remove_enum_all()

(

)

-> None

Remove all enumerations.

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

remove_enum_name()

(

enum_name

: str

)

-> None

Removes the enumeration specifed by the string.

Parameters

[in]

enum_name

Enumeration name to remove.

Exceptions

TrekError

15007 - TREK_DATA_DOES_NOT_EXIST

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.

remove_enum_value()

(

enum_value

: int

)

-> None

Removes the enumeration specifed by the integer.

Parameters

[in]

enum_value

Value to remove.

Exceptions

TrekError

15007 - TREK_DATA_DOES_NOT_EXIST

Reimplemented in Enumerator, RangeEnumerator, and SignedEnumerator.