pscfpp.command.Command Class Reference

A single command, with a label and zero or more parameters. More...

Inheritance diagram for pscfpp.command.Command:

Public Member Functions
def	__init__ (self, line)
	Constructor. More...
def	nParam (self)
	Number of parameter / arguments of the command. More...
def	param (self, i=0)
	Return parameter number i. More...
def	setParam (self, value, i=0)
	Set the value of a specific command parameter. More...
Public Member Functions inherited from pscfpp.text.Record
def	__init__ (self, line)
	Constructor. More...
def	__str__ (self)
	String representation - line from which Record was constructed. More...

Detailed Description

A single command, with a label and zero or more parameters.

The first string (or field) in a command is the label, and subsequent space separated strings are interpreted as command parameters. All fields are stored verbatim as strings.

Definition at line 153 of file command.py.

Constructor & Destructor Documentation

__init__()

def pscfpp.command.Command.__init__	(		self,
			line
	)

Constructor.

Parameters

line	string containing the command line

Reimplemented from pscfpp.text.Record.

Definition at line 160 of file command.py.

References pscfpp.text.Record.fields, Pscf::Pspc::FieldState< D, DArray< double > >.fields(), Pscf::Pspc::FieldState< D, FT >.fields(), Pscf::Pspg::FieldState< D, FT >.fields(), pscfpp.command.Command.label, pscfpp.param.Composite.label, pscfpp.param.Parameter.label, pscfpp.param.Array.label, pscfpp.param.Matrix.label, Util::XmlAttribute.label(), Util::XmlEndTag.label(), Util::XmlStartTag.label(), Util::ArrayParam< Type >.label(), Util::MatrixParam< Type >.label(), and Util::Parameter.label().

Member Function Documentation

nParam()

def pscfpp.command.Command.nParam

(

self

)

Number of parameter / arguments of the command.

Definition at line 167 of file command.py.

References pscfpp.text.Record.fields, Pscf::Pspc::FieldState< D, DArray< double > >.fields(), Pscf::Pspc::FieldState< D, FT >.fields(), and Pscf::Pspg::FieldState< D, FT >.fields().

param()

def pscfpp.command.Command.param	(		self,
			i = 0
	)

Return parameter number i.

Parameters

i	index of command parameter / argument

Definition at line 175 of file command.py.

References pscfpp.text.Record.fields, Pscf::Pspc::FieldState< D, DArray< double > >.fields(), Pscf::Pspc::FieldState< D, FT >.fields(), and Pscf::Pspg::FieldState< D, FT >.fields().

Referenced by pscfpp.output.State.__init__(), and pscfpp.output.State.__str__().

setParam()

def pscfpp.command.Command.setParam	(		self,
			value,
			i = 0
	)

Set the value of a specific command parameter.

Parameters

value	new value for the specified command parameter
i	index of command parameter (0 by default)

Definition at line 184 of file command.py.

References pscfpp.text.Record.fields, Pscf::Pspc::FieldState< D, DArray< double > >.fields(), Pscf::Pspc::FieldState< D, FT >.fields(), and Pscf::Pspg::FieldState< D, FT >.fields().

---

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

• command.py