Package autodesk_toxik :: Module admin :: Class Administrable

Class Administrable

 object --+    
          |    
Boost.Python.instance --+
              |
             Administrable

Known Subclasses:

The Project, User and Machine classes all derive from the Administrable base class. Note that you cannot create an instance of these classes through their constructors. You must go through their respective <Administrable>Mgr class to create or get an existing Administrable.

Instance Methods

__init__(...)
Raises an exception This class cannot be instantiated from Python

__reduce__(...)
helper for pickle

str

getDescription(...)
Returns: The administrable description string.

str

getFolder(...)
Returns: The absolute path of the directory where the administrable file is (str).

str

getFullName(...)
Returns: The absolute path of the administrable file without the extension (str).

[str]

getGroups(...)
Returns: The list of setting groups for this administrable.

str

getName(...)
Returns: The administrable name (str).

str

getPath(...)
Returns: The absolute path of the administrable file with the extension (str).

str

getSetting(...)
Returns: The value for the specified (group, key) setting pair.

[(str, str)]

getSettings(...)
Returns: List of settings of this administrable for the specified group, a mapping of key-value pairs (tuples).

save(...)
Saves the current administrable settings to its file on disk.

setAsCurrent(...)
Sets this administrable as the current one (invokes the <Administrable>Mgr.setCurrent() method).

setDescription(...)
Sets the administrable description string.

setSetting(...)
Sets the value for the specified (group, key) setting pair for this administrable.

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

getDescription(...)

Returns: str: The administrable description string.

getFolder(...)

Returns: str: The absolute path of the directory where the administrable file is (str).

getFullName(...)

Returns: str: The absolute path of the administrable file without the extension (str).

getGroups(...)

Returns: [str]: The list of setting groups for this administrable.

getName(...)

Returns: str: The administrable name (str).

getPath(...)

Returns: str: The absolute path of the administrable file with the extension (str).

getSetting(...)

Parameters:

group (str)
key (str)

Returns: str

The value for the specified (group, key) setting pair.

getSettings(...)

Parameters:

group (str)

Returns: [(str, str)]

List of settings of this administrable for the specified group, a mapping of key-value pairs (tuples).

setAsCurrent(...)

Sets this administrable as the current one (invokes the <Administrable>Mgr.setCurrent() method). For example, the following two lines of code are equivalent:

   admin.ProjectMgr().setCurrent(proj)
   proj.setAsCurrent()

setDescription(...)

Sets the administrable description string.

Parameters:

desc (str) - Description string.

setSetting(...)

Sets the value for the specified (group, key) setting pair for this administrable.

Parameters:

group (str)
key (str)
value (str)

Class Administrable

__init__(...) (Constructor)

__reduce__(...)

getDescription(...)

getFolder(...)

getFullName(...)

getGroups(...)

getName(...)

getPath(...)

getSetting(...)

getSettings(...)

setAsCurrent(...)

setDescription(...)

setSetting(...)

init(...)
(Constructor)

reduce(...)