Class ProjectRow

Construct a Project Row for the given Project instance based an an entry index.

Overrides: object.__init__

Return string representation

Overrides: object.__repr__

Returns:
Structure:  The entry's structure

Arguments:
props:      True  - Associated properties are included 
            in the returned Structure.
            False - Associated properties are excluded from
            the returne Structure.
copy:       True  - Makes and returns a duplicate of the entry's CT
            False - Returns the original CT for the entry

WARNING: The current default (copy=True) is to make a duplicate
of the entry's structure.  These will be marked for garbage 
collection once they go out of scope in the calling code, but if, 
for example, you are in a loop your memory usage will grow until 
the loop is exited (and it may even take a while for it to drop
since garbage collection is not necessarily immediate).  This can 
cause large memory usage if, for example,  you are iterating over 
a large number entries.  In some cases you may want to
explicitly delete the returned Structure.  For example,
in a loop iterating over a large number of entries you may want to
delete the Structure while still in the loop (after you're 
done processing the Structure) to prevent memory bloat.

Set the structure of the entry to the specified structure.

Arguments:
struct (required) - Set the entry to this Structure object
copy   (optional, default True) -  
                    If True, a copy of the Structure (CT) is 
                    made and that copy is used to set the entry.
                    
                    If False, the original Structure, struct,
                    is placed into the project table.  Doing this
                    hands off control of struct and you should no
                    longer use struct.

props  (option, default True) -
                    If True, update properties in the entry.
                    If False, properties are ignored.

Set Project Row property value prop is the name of the property, i.e. the key

Obsolete. Use ProjectRow.in_workspace property instead.

doc

Value:

'''Inclusion state of the entry (NOT_IN_WORKSPACE/IN_WORKSPACE/LOCKED_ IN_WORKSPACE) WARNING: This property should NOT be treated as a boolean.'''

structure

This attribute is obsolete. Please use ProjectRow.getStructure() and 
ProjectRow.setStructure() instead.

Reference for the entry Structure.  Associated properties are not included.
Properties can be accessed directly from the project via getPropertyNames()

If you wish to update a structure in the project, you may work on that 
structure directly. Do something like:

for row in pt.selected_rows:
  for atom in row.structure.atom
    atom.color = 44 #blue

You must be careful that the project entry you modify is not also
currently included in the Workspace.  When that entry is excluded 
from the Workspace, its updated contents will be placed into the 
entry in the project, potentially overwriting any direct changes
you made to the project entry.

If you want to pass the returned structure to another operation, make a
copy of it first as follows:
    st = row.structure.copy()

The Structure returned by row.structure will be invalid after the entry is
edited by Maestro or after setting row.structure to another structure.

WARNING: If you are working with large numbers of entries, you
may experience high memory usage.  This typically happens when
retrieving structures while iterating over large number of entries,
but will increase for every structure you retrieve. So if your
cumulative total of retrieved structurs is large then your memory
foot print is likely to be large as well.   This is because
the returned structures are configured not to be garbage collected.
You may wish to explicitly delete each Structure once you've finished
processing it in order to minimize memory usage.

Get Method:

_getStructure(self) - See docstring for structure property

Set Method:

_setStructure(self, struct, copy=True) - See docstring for structure property

title

The title of the entry

Get Method:

_getTitle(self)

Set Method:

_setTitle(self, title)

index

Project index of the row

Get Method:

_getProjectIndex(self)

entry_id

Entry ID of the row

Get Method:

_getEntryID(self)

group

EntryGroup for the row

Get Method:

_getGroup(self)

in_workspace

Inclusion state of the entry (NOT_IN_WORKSPACE/IN_WORKSPACE/LOCKED_IN_WORKSPACE) WARNING: This property should NOT be treated as a boolean.

Get Method:

_getEntryInWorkspace(self)

Set Method:

_setEntryInWorkspace(self, include)

is_selected

Whether the entry is selected

Get Method:

_getEntryIsSelected(self)

Set Method:

_setEntryIsSelected(self, select)

read_only

Whether the entry is read only or not

Get Method:

_getEntryIsReadOnly(self)

Set Method:

_setEntryIsReadOnly(self, is_read_only)

deletable

Whether the entry is deletable or not

Get Method:

_getEntryIsDeletable(self)

Set Method:

_setEntryIsDeletable(self, deletable)

cms_structure_reader

Return StructureReader for associated CMS file or EmptyIterator if there is no associated file

Get Method:

_getCMSStructureReader(self) - If there is no associated cms file, then we return an empty iterator.

cms_file

Return associated CMS file or None if there is no associated file

Get Method:

_getCMSFile(self) - Returns the file instead of the reader.

surfaces

Return an interator to the surface objects available for this entry

Get Method:

_getSurfaces(self) - Returns an iterator to the available surfaces