Package schrodinger :: Module project :: Class EntryGroup
[hide private]
[frames] | no frames]

Class EntryGroup

object --+
         |
        EntryGroup

A class which represents an entry group in the project table. Entry groups are returned from the Project.group property.

The entry group itself has a number of properties:

collapsed - set or get the entry collapse/expand state

title - set or get the entry group title (What the user sees)

name - set or get the entry group name (Hidden unique name)

The following iterators are available which are very similar to those available from the Project class but only operate on the entries in the group:

all_rows - an iterator for all the rows in the group

selected_rows - an iterator for selected rows in the group

included_rows - an iterator for included rows in the group

Instance Methods [hide private]
 
__init__(self, pt, group_index)
x.__init__(...) initializes x; see help(type(x)) for signature
 
__int__(self)
 
_getName(self)
Return the name of this group
 
_setName(self, gname)
Set the name of this group
 
__str__(self)
str(x)
 
_getTitle(self)
Return the title of this group
 
_setTitle(self, gtitle)
Set the title of this group
 
_getCollapsed(self)
Return the collapsed state of this group
 
_setCollapsed(self, collapsed)
Set the collapsed state of this group
 
_getAllRowsIterator(self)
 
_getSelectedRowsIterator(self)
 
_getIncludedRowsIterator(self)
Private method.

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

Class Variables [hide private]
  name = property(_getName, _setName, None, "Get and set the nam...
  title = property(_getTitle, _setTitle, None, "Get and set the ...
  collapsed = property(_getCollapsed, _setCollapsed, None, "Get ...
  all_rows = property(_getAllRowsIterator, doc= "Iterator for al...
  selected_rows = property(_getSelectedRowsIterator, doc= "Itera...
  included_rows = property(_getIncludedRowsIterator, doc= "Itera...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, pt, group_index)
(Constructor)

 

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

Overrides: object.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

_getIncludedRowsIterator(self)

 

Private method. The property should be used to access the iterator.


Class Variable Details [hide private]

name

Value:
property(_getName, _setName, None, "Get and set the name of this group\
")

title

Value:
property(_getTitle, _setTitle, None, "Get and set the title of this gr\
oup")

collapsed

Value:
property(_getCollapsed, _setCollapsed, None, "Get and set the collapse\
d state of this group")

all_rows

Value:
property(_getAllRowsIterator, doc= "Iterator for all rows in the group\
 using the visible project table order")

selected_rows

Value:
property(_getSelectedRowsIterator, doc= "Iterator for the selected row\
s in the group usig the visible project table order")

included_rows

Value:
property(_getIncludedRowsIterator, doc= "Iterator for all included row\
s in the group.  Order should be treated as random")