Package autodesk_toxik :: Module admin :: Class UdaMgr

Class UdaMgr

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

Use this class to manipulate user-defined attributes (UDAs). User-defined attributes are defined globally in a Toxik project and each Toxik component can have a value for a specific UDA or not.

Instance Methods

__init__(...)
Constructor.

__reduce__(...)
helper for pickle

create(...)
Creates a new user-defined attribute in the current Toxik project.

bool

exists(...)
Returns: True if the user-defined attribute exists in the current Toxik project.

[str]

getAll(...)
Returns: A list of all existing user-defined attributes defined in the current Toxik project.

str

getValue(...)
Returns: The value of the specified user-defined attribute from the specified component.

remove(...)
Removes an existing user-defined attribute.

removeValue(...)
Removes the specified user-defined attribute from the specified component.

rename(...)
Renames an existing user-defined attribute.

setValue(...)
Sets the value of a user-defined attribute on the specified component.

Inherited from Boost.Python.instance: __new__

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

Class Variables
	__instance_size__ = `24`

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Constructor. Requires an opened project to succeed.

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

create(...)

Creates a new user-defined attribute in the current Toxik project.

Parameters:

name (str)

exists(...)

Parameters:

name (str)

Returns: bool

True if the user-defined attribute exists in the current Toxik project.

getAll(...)

Returns: [str]: A list of all existing user-defined attributes defined in the current Toxik project.

getValue(...)

Parameters:

path (str)
name (str)

Returns: str

The value of the specified user-defined attribute from the specified component.

Raises:

Exception - If the user-defined attribute does not exist in the current Toxik project.

remove(...)

Removes an existing user-defined attribute.

Parameters:

name (str)

removeValue(...)

Removes the specified user-defined attribute from the specified component.

Parameters:

path (str)
name (str)

Raises:

Exception - If the user-defined attribute does not exist in the current Toxik project.

rename(...)

Renames an existing user-defined attribute.

Parameters:

oldName (str)
newName (str)

setValue(...)

Sets the value of a user-defined attribute on the specified component.

Parameters:

path (str)
name (str)
value (str)

Raises:

Exception - If the user-defined attribute does not exist in the current Toxik project.

Class UdaMgr

__init__(...) (Constructor)

__reduce__(...)

create(...)

exists(...)

getAll(...)

getValue(...)

remove(...)

removeValue(...)

rename(...)

setValue(...)

init(...)
(Constructor)

reduce(...)