Package autodesk_toxik :: Module admin :: Class FindUtil

Class FindUtil

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

The FindUtil class can be used to perform search queries in the Toxik library.

Nested Classes
	StrOp

Instance Methods

__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

__reduce__(...)
helper for pickle

[str]

byAttribute(...)
Search by attribute value.

[str]

byDescription(...)
Search by comment.

[str]

byName(...)
Search by component name.

[str]

byType(...)
Search by component type (LibraryMgr.Type enum).

Inherited from Boost.Python.instance: __new__

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

Class Variables
	__instance_size__ = `88`

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:

path (str) - The constructor is given a folder path to search in.
recursive (bool) - This parameter is a bool indicating whether the search is applied recursively in sub-folders.

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

byAttribute(...)

Search by attribute value. op is a FindUtil.StrOp enum.

Returns: [str]: list of str containing component names.

byDescription(...)

Search by comment. op is a FindUtil.StrOp enum.

Returns: [str]: list of str containing component names.

byName(...)

Search by component name. op is a FindUtil.StrOp enum.

Returns: [str]: list of str containing component names.

byType(...)

Search by component type (LibraryMgr.Type enum).

Returns: [str]: list of str containing component names.

Class FindUtil

__init__(...) (Constructor)

__reduce__(...)

byAttribute(...)

byDescription(...)

byName(...)

byType(...)

init(...)
(Constructor)

reduce(...)