| | |
- builtins.object
-
- CdbFolders
- enum.Enum(builtins.object)
-
- Folders
class CdbFolders(builtins.object) |
| |
CdbFolders(folder: IasCdb.CdbFolders.Folders, cdb_parent_path: str) -> None
CdbFolder is the python translation of the java CdbFolder.java
The differences are mostly due to the fact that python implemntation
of enumerated differs from java
|
| |
Methods defined here:
- __init__(self, folder: IasCdb.CdbFolders.Folders, cdb_parent_path: str) -> None
- Constructor
Args:
folder: the forlder of this object
cdb_parent_path: the path of the folder containig the CDB
- delete(self) -> bool
- Delete the subfolder represented by this object, if it exists.
Returns:
True if the folder has been deleted, False otherwise
- exists(self) -> bool
- Check if the subfolder exists
Returns:
True if the folder exists, False otherwise
- get_folder(self, create: bool) -> str
- Get the path of the CDB sub folder and if it is the case, creates it.
Args:
create: if True and the subfolder does not exist, then create it
Returns:
the path to the subfolder.
Static methods defined here:
- create_folders(cdb_parent_path: str)
- Create all the subfolders of the CDB.
If a subfolder already exists then nothing is done
Args:
cdbParentPath: The path to the parent of the CDB
- get_subfolder(cdb_parent_path: str, folder: IasCdb.CdbFolders.Folders, create: bool) -> str
- Get the path of a CDB folder and if it is the case, creates the folder
Args:
cdbParentPath: The path to the parent of the CDB
folder: the CDB folder to create
create: if True and the subfolder does not exist, then create it
Returns:
the path to the subfolder
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- ALL_FOLDERS = {<Folders.ROOT: 1>: 'CDB', <Folders.SUPERVISOR: 2>: 'Supervisor', <Folders.DASU: 3>: 'DASU', <Folders.ASCE: 4>: 'ASCE', <Folders.IASIO: 5>: 'IASIO', <Folders.TF: 6>: 'TF', <Folders.TEMPLATE: 7>: 'TEMPLATE', <Folders.PLUGIN: 8>: 'PLUGIN', <Folders.CLIENT: 9>: 'CLIENT'}
|
class Folders(enum.Enum) |
| |
Folders(value, names=None, *, module=None, qualname=None, type=None, start=1)
An enumeration.
|
| |
- Method resolution order:
- Folders
- enum.Enum
- builtins.object
Data and other attributes defined here:
- ASCE = <Folders.ASCE: 4>
- CLIENT = <Folders.CLIENT: 9>
- DASU = <Folders.DASU: 3>
- IASIO = <Folders.IASIO: 5>
- PLUGIN = <Folders.PLUGIN: 8>
- ROOT = <Folders.ROOT: 1>
- SUPERVISOR = <Folders.SUPERVISOR: 2>
- TEMPLATE = <Folders.TEMPLATE: 7>
- TF = <Folders.TF: 6>
Data descriptors inherited from enum.Enum:
- name
- The name of the Enum member.
- value
- The value of the Enum member.
Readonly properties inherited from enum.EnumMeta:
- __members__
- Returns a mapping of member name->value.
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.
| |