IMP.pmi.topology.System Class Reference

Represent the root node of the global IMP.atom.Hierarchy. More...

Inherits _SystemBase.

Detailed Description

Represent the root node of the global IMP.atom.Hierarchy.

Note

This class is only available in Python.

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

Public Member Functions
def	__init__
	Constructor. More...
def	add_protocol_output
	Capture details of the modeling protocol. More...
def	build
	Build all states. More...
def	create_state
	Makes and returns a new IMP.pmi.topology.State in this system. More...
def	get_hierarchy
	Return the top-level IMP.atom.Hierarchy node for this system. More...
def	get_number_of_states
	Returns the total number of states generated. More...
def	get_states
	Get a list of all State objects in this system. More...

Constructor & Destructor Documentation

def IMP.pmi.topology.System.__init__	(		self,
			model = None,
			name = 'System'
	)

Constructor.

Parameters

model	The IMP::Model in which to construct this system.
name	The name of the top-level hierarchy node.

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

Member Function Documentation

def IMP.pmi.topology.System.add_protocol_output	(		self,
			p
	)

Capture details of the modeling protocol.

Parameters

p	an instance of IMP.pmi.output.ProtocolOutput or a subclass.

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

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

Build all states.

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

def IMP.pmi.topology.System.create_state

(

self

)

Makes and returns a new IMP.pmi.topology.State in this system.

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

def IMP.pmi.topology.System.get_hierarchy

(

self

)

Return the top-level IMP.atom.Hierarchy node for this system.

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

def IMP.pmi.topology.System.get_number_of_states

(

self

)

Returns the total number of states generated.

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

def IMP.pmi.topology.System.get_states

(

self

)

Get a list of all State objects in this system.

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

---

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

• pmi/topology/__init__.py