BaseEnumerator Class Reference
Abstract Base Class for Enumerators. More...
Inherits NamedItem.
Inherited by Enumerator, and RangeEnumerator.
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and finalization. | |
| def | clone () -> object |
| 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 |
| Adds the string values as enumeration for the unsigned integer value. More... | |
| def | get_enum_name (enum_value: int) -> str |
| Finds the corresponding string value for the specified unsigned integer. More... | |
| def | get_enum_names () -> List[str] |
| Gets a list of the string enumerations. More... | |
| def | get_enum_ranges () -> List[EnumeratorRangePoint] |
| Gets a list of the begin and end values for which enumerators exist. More... | |
| def | get_enum_value (enum_name: str) -> int |
| Finds the corresponding unsigned integer value for the specified string. More... | |
| def | get_enum_values () -> List[int] |
| Gets a list of the integer values. More... | |
| def | get_number_of_enumerations () -> int |
| Returns the current number of enumerations. More... | |
| def | remove_enum_all () -> None |
| Remove all enumerations. More... | |
| def | remove_enum_name (enum_name: str) -> None |
| Removes the enumeration specifed by the string. More... | |
| def | remove_enum_value (enum_value: int) -> None |
| Removes the enumeration specifed by the integer. More... | |
 Public Member Functions inherited from NamedItem | |
| def | BaseEnumerator ( Optional[NamedItem] named_item=None) -> None |
| Class initializer. More... | |
| def | __eq__ (named_item: object) -> bool |
| Equality operator "==". More... | |
| def | copy (copy_from: object) -> None |
| Copies the contents of the provided 'copy_from' NamedItem into this NamedItem. More... | |
| def | initialize () -> None |
| Initializes the object. More... | |
| def | get_alias () -> str |
| Returns the alias of the item. More... | |
| def | get_name () -> str |
| Returns the name of the item. More... | |
| def | get_long_description () -> str |
| Returns the long description of the item. More... | |
| def | get_short_description () -> str |
| Returns the short description of the item. More... | |
| def | get_user_description () -> str |
| Returns the user description of the item. More... | |
| def | get_owner () -> str |
| Returns the owner of the item. More... | |
| def | set_name (name: str) -> None |
| Sets the name of the item. More... | |
| def | set_alias (alias: str) -> None |
| Sets the alias of the item. More... | |
| def | set_short_description (description: str) -> None |
| Sets the short description of the item. More... | |
| def | set_long_description (description: str) -> None |
| Sets the long description of the item. More... | |
| def | set_user_description (description: str) -> None |
| Sets the user description of the item. More... | |
| def | set_owner (owner: str) -> None |
| Sets the owner of the item. More... | |
Detailed Description
Abstract Base Class for Enumerators.
- See also
- enumerator.Enumerator
- rangeenumerator.RangeEnumerator
Member Function Documentation
◆ add_enum()
| add_enum | ( | int_value | : int |