Difference between revisions of "Get Title"

From PyMOLWiki
Jump to navigation Jump to search
Line 1: Line 1:
===DESCRIPTION===  
+
==DESCRIPTION==
'''get_title''' retrieves a text string to the state of a particular object which will be displayed when the state is active.
+
'''get_title''' retrieves a text string to the state of a particular object which will be displayed when the state is active.  This is useful for printing the names of objects (given a state).
  
===USAGE===
+
==USAGE==
set_title object,state
+
<source lang="python">
 +
set_title object,state
 +
</source>
  
===PYMOL API===
+
==PYMOL API==
 
<source lang="python">
 
<source lang="python">
 
  cmd.set_title(string object,int state,string text)  
 
  cmd.set_title(string object,int state,string text)  
 +
</source>
 +
 +
== Example ==
 +
Print out all the object names of the ensemble of states loaded in:
 +
<source lang="python">
 +
for x in range(numStates):
 +
  print cmd.get_title("objName", x)
 
</source>
 
</source>
  
 
[[Category:Commands|get_title]]
 
[[Category:Commands|get_title]]
 
[[Category:States]]
 
[[Category:States]]

Revision as of 11:25, 27 January 2009

DESCRIPTION

get_title retrieves a text string to the state of a particular object which will be displayed when the state is active. This is useful for printing the names of objects (given a state).

USAGE

set_title object,state

PYMOL API

 cmd.set_title(string object,int state,string text)

Example

Print out all the object names of the ensemble of states loaded in:

for x in range(numStates):
  print cmd.get_title("objName", x)