AEState :: Setting :: Group :: Class Group

[frames] | no frames]

Class Group

object --+    
         |    
      list --+
             |
            Group

Named collection of related Settings.

Both the name and the state of the group should be considered public readable.

Instance Methods

__init__(self, state, name=None)
Stores the Group state and its name.

source code

__str__(self)
str(x)

source code

Group

newGroup(self, name)
Adds a subgroup to this group with the given name.

source code

2-tuple of (integer, Setting or Group)

iterSettings(self, reverse=False)
Iterates over the Settings and Groups stored in this Group.

source code

Inherited from list: __add__, __contains__, __delitem__, __delslice__, __eq__, __ge__, __getattribute__, __getitem__, __getslice__, __gt__, __hash__, __iadd__, __imul__, __iter__, __le__, __len__, __lt__, __mul__, __ne__, __new__, __repr__, __reversed__, __rmul__, __setitem__, __setslice__, append, count, extend, index, insert, pop, remove, reverse, sort

Inherited from object: __delattr__, __reduce__, __reduce_ex__, __setattr__

Instance Variables

string

name
Name of the group

AEState.AEState

state
Object whose properties are contained within this group

Properties

Inherited from object: __class__

Method Details

init(self, state, name=None)
(Constructor)

Stores the Group state and its name.

Parameters:

state (AEState.AEState) - Object whose properties are contained within this group
name (string) - Name of the group

Returns:

new list

Overrides: list.__init__

str(self)
(Informal representation operator)

str(x)

Overrides: object.__str__: (inherited documentation)

newGroup(self, name)

Adds a subgroup to this group with the given name.

Parameters:

name (string) - Name of the new group

Returns: Group

The newly created group

iterSettings(self, reverse=False)

Iterates over the Settings and Groups stored in this Group. Yield both the index of the item and the item itself.

Parameters:

reverse (boolean) - Iterate in reverse direction?

Returns: 2-tuple of (integer, Setting or Group)

Next index and setting object on each iteration