IMP.pmi.topology.State Class Reference

Stores a list of Molecules all with the same State index. More...

Inherits _SystemBase.

Detailed Description

Stores a list of Molecules all with the same State index.

Also stores number of copies of each Molecule for easy Selection.

Note

This class is only available in Python.

Definition at line 140 of file pmi/topology/__init__.py.

Public Member Functions
def	__init__
	Define a new state. More...
def	build
	call build on all molecules (automatically makes clones) More...
def	create_molecule
	Create a new Molecule within this State. More...
def	get_molecule
	Access a molecule by name and copy number. More...
def	get_molecules
	Return a dictionary where key is molecule name and value are the list of all copies of that molecule in setup order. More...

Constructor & Destructor Documentation

def IMP.pmi.topology.State.__init__	(		self,
			system,
			state_index
	)

Define a new state.

Parameters

system	the PMI System
state_index	the index of the new state

ote It's expected that you will not use this constructor directly, but rather create it with pmi::System::create_molecule()

Definition at line 148 of file pmi/topology/__init__.py.

Member Function Documentation

def IMP.pmi.topology.State.build	(		self,
			kwargs
	)

call build on all molecules (automatically makes clones)

Definition at line 209 of file pmi/topology/__init__.py.

def IMP.pmi.topology.State.create_molecule	(		self,
			name,
			sequence = '',
			chain_id = ''
	)

Create a new Molecule within this State.

Parameters

name	the name of the molecule (string) it must not be already used
sequence	sequence (string)
chain_id	Chain id to assign to this molecule

Definition at line 182 of file pmi/topology/__init__.py.

def IMP.pmi.topology.State.get_molecule	(		self,
			name,
			copy_num = 0
	)

Access a molecule by name and copy number.

Parameters

name	The molecule name used during setup
copy_num	The copy number based on input order. Default: 0. Set to 'all' to get all copies

Definition at line 168 of file pmi/topology/__init__.py.

def IMP.pmi.topology.State.get_molecules

(

self

)

Return a dictionary where key is molecule name and value are the list of all copies of that molecule in setup order.

Definition at line 162 of file pmi/topology/__init__.py.

---

The documentation for this class was generated from the following file:

• pmi/topology/__init__.py