Package mvpa :: Package misc :: Module attributes :: Class CollectableAttribute

[hide private]
[frames] | no frames]

# Class CollectableAttribute

source code

Base class for any custom behaving attribute intended to become part of a collection.

Derived classes will have specific semantics:

- StateVariable: conditional storage
- AttributeWithUnique: easy access to a set of unique values within a container
- Parameter: attribute with validity ranges.
  - ClassifierParameter: specialization to become a part of Classifier's params collection
  - KernelParameter: --//-- to become a part of Kernel Classifier's kernel_params collection

Those CollectableAttributes are to be groupped into corresponding collections for each class by statecollector metaclass, ie it would be done on a class creation (ie not per each object)

Instance Methods | [hide private]

__init__(self, name=None, doc=None, index=None) x.__init__(...) initializes x; see help(type(x)) for signature | source code

_getVirtual(self) | source code

_setVirtual(self, value) | source code

_get(self) | source code

_set(self, val) | source code

isSet(self) | source code

reset(self) Simply reset the flag | source code

__str__(self) str(x) | source code

_getName(self) | source code

_setName(self, name) Set the name of parameter | source code

name(self) | source code

Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Class Variables | [hide private]

| _instance_index = `0`
| value = `property(_getVirtual, _setVirtual)`

Properties | [hide private]

Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, name=None, doc=None, index=None)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
  (inherited documentation)

### isSet(self)

source code

Decorators:
  - `@property`

### __str__(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__
  (inherited documentation)

### _setName(self, name)

source code

Set the name of parameter

Should not be called for an attribute which is already assigned to a collection