 |
Telescience Resource Kit
TReK Python
5.4.0 ART
|
|
|
Telescience Resource Kit
TReK Python
5.4.0 ART
|
This class determine a parameter's dependency by checking a series of dependencies of which one must be true. More...
Inherits Dependency.
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and finalization. | |
| def | OrDependency ( Optional[OrDependency] or_dependency=None, Optional[c_void_p] native_ptr=None, is_clone: bool=False -> def ) -> def |
| Class initializer. More... | |
| def | clone ( -> OrDependency ) -> 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' OrDependency. More... | |
| def | load_file (filename: str -> None ) -> def |
| Loads the OrDependency definition from the specified file. More... | |
| def | save_file (filename: str -> None ) -> def |
| Saves the OrDependency definition to the specified file. More... | |
OrDependency Settings | |
Functions handling OrDependency Settings. | |
| def | add_dependency (dependency: Dependency -> None ) -> def |
| Adds a dependency. More... | |
| def | check ( -> bool ) -> def |
| Checks for the dependency. More... | |
| def | clear_all_dependencies ( -> None ) -> def |
| Removes all of the dependencies. | |
| def | get_dependency (index: int -> Union[Dependency, None] ) -> def |
| Gets the dependency at the specified index. More... | |
| def | get_number_of_dependencies ( -> int ) -> def |
| Gets the number of dependencies. More... | |
| def | remove_dependency (index: int -> None ) -> def |
| Removes the dependency at the specified index. More... | |
 Public Member Functions inherited from Dependency | |
| def | OrDependency ( -> None ) -> def |
| Class initializer. More... | |
| def | get_type ( -> DependencyType ) -> def |
| Gets the type of Dependency. 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 | __eq__ (named_item: object -> bool ) -> def |
| Equality operator "==". 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... | |
This class determine a parameter's dependency by checking a series of dependencies of which one must be true.
| ( | or_dependency | : Optional[OrDependency] | |
| native_ptr | : Optional[c_void_p] | ||
| is_clone | : bool | ||
| ) | -> def |
Class initializer.
| [in] | or_dependency | OrDependency to create a copy (optional). By default, initializes a new instance. |
| [in] | native_ptr | (Optional) Internal parameter, do not provide. |
| [in] | is_clone | (Optional) Internal parameter, do not provide. |
Reimplemented from Dependency.
| ( | dependency | : Dependency | ) | -> None |
Adds a dependency.
| [in] | dependency | The dependency to add. A copy is made of the object. |
| ( | ) | -> bool |
Checks for the dependency.
Checks to see if all of the dependency items are true.
| ( | copy_from | : object | ) | -> None |
Copies the contents of the provided 'copy_from' OrDependency.
| [in] | copy_from | OrDependency to copy from. |
| TypeError | if 'copy_from' is not a OrDependency. |
Reimplemented from NamedItem.
| ( | index | : int | ) | -> Union[Dependency, None] |
Gets the dependency at the specified index.
If successful the method returns the internal dependency at the requested index.
| [in] | index | The index to retrieve. |
| ( | ) | -> int |
Gets the number of dependencies.
| ( | filename | : str | ) | -> None |
Loads the OrDependency definition from the specified file.
Reads an XML OrDependency.
| [in] | filename | The file from which to load the OrDependency object. |
| ( | index | : int | ) | -> None |
Removes the dependency at the specified index.
| [in] | index | The index to remove. |
| TrekError | 15007 - TREK_DATA_DOES_NOT_EXIST |
| ( | filename | : str | ) | -> None |
Saves the OrDependency definition to the specified file.
Writes an XML OrDependency.
| [in] | filename | The file to save the and dependency object. |