pscfpp.param.Parameter Class Reference

A Parameter represents a single parameter in a parameter file. More...

Public Member Functions
	__init__ (self, label, val)
	Constructor.
	setValue (self, val)
	Set the new value to the Parameter object.
	__str__ (self)
	Unindented string representation of this Parameter object.
	getString (self, depth='')
	Indented string for the Parameter object.
	returnData (self)
	Return the stored value.

Detailed Description

A Parameter represents a single parameter in a parameter file.

A Parameter object contains the label and value of a single parameter. A single parameter is represented in a parameter file by a single line containing a label followed by one or more values separated by spaces.

Definition at line 452 of file param.py.

Constructor & Destructor Documentation

__init__()

pscfpp.param.Parameter.__init__	(		self,
			label,
			val )

Constructor.

Parameters

label	label string for the individual parameter
val	parameter value

Definition at line 460 of file param.py.

References pscfpp.param.getValue(), pscfpp.command.Command.label, pscfpp.param.Composite.label, label, and val.

Member Function Documentation

setValue()

pscfpp.param.Parameter.setValue	(		self,
			val )

Set the new value to the Parameter object.

This function sets the new value, parameter val, for this Parameter object.

Parameters

val	the expected new value.

Definition at line 475 of file param.py.

References pscfpp.param.getValue(), and val.

__str__()

pscfpp.param.Parameter.__str__

(

self

)

Unindented string representation of this Parameter object.

This function returns the unindented string representation for this Parameter object, containing a label followed by the value.

Definition at line 491 of file param.py.

References pscfpp.param.Composite.getString(), and getString().

getString()

pscfpp.param.Parameter.getString	(		self,
			depth = '' )

Indented string for the Parameter object.

This function returns the indented string representation for the Parameter object in the param file format, with prefix depth as the passed-in parameter.

Parameters

depth

the spaces string as the prefix depth.

Definition at line 504 of file param.py.

References val.

Referenced by pscfpp.param.Array.__str__(), pscfpp.param.Matrix.__str__(), and __str__().

returnData()

pscfpp.param.Parameter.returnData

(

self

)

Return the stored value.

This function returns the value stored in the Parameter object.

Return value:

The value stored in the Parameter object.

Definition at line 531 of file param.py.

References val.

---

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

• param.py