Container for data of an array in a param file. More...

Public Member Functions
	__init__ (self, label, file, val=None)
	Constructor.

	read (self, file)
	Read the elements of this Array from a file.

	__str__ (self)
	String representation of this Array object.

	getString (self, depth='')
	Indented string representation of this Array object.

	returnData (self)
	Return the value of this Array, as a list of element values.

	setValue (self, val)
	Set the new value to the Array object.

Detailed Description

Container for data of an array in a param file.

An Array object represents a one-dimensional array of values. An array appears in a parameter file in a multi-line format with one element value per line, delimited by square brackets. The first lines contains the array label followed immediately by an opening bracket, and the last line contains a closing bracket. Elements of the array appear between these lines in order of increasing array index, starting from 0.

Definition at line 545 of file param.py.

Constructor & Destructor Documentation

◆ init()

pscfpp.param.Array.__init__	(	self,
		label,
		file,
		val = None )

Constructor.

Parameters

label	label string for the Array
file	a file object, open for reading
val	stored value for the Array, default to None

Definition at line 554 of file param.py.

Member Function Documentation

◆ read()

pscfpp.param.Array.read	(		self,
			file )

Read the elements of this Array from a file.

This function reads the elements of a multi-line array from the file object that is passed as a parameter. On entry, the opening line containing the opening bracket must already have been processed, and the first unread line of the file should contain the value of the first element. Reading stops stops when the closing "]" is read.

Parameters

file	a file object, open for reading

Definition at line 575 of file param.py.

References pscfpp.param.getValue(), pscfpp.param.Array.val, pscfpp.param.Matrix.val, and pscfpp.param.Parameter.val.

Referenced by pscfpp.command.Script.__init__(), pscfpp.field.Field.__init__(), pscfpp.output.Thermo.__init__(), pscfpp.param.Array.__init__(), pscfpp.param.Composite.__init__(), and pscfpp.param.Matrix.__init__().

◆ str()

pscfpp.param.Array.__str__ ( self )

String representation of this Array object.

This function return the string representation of this Array object in the multi-line indented param file format, with no indentation of the opening line.

Definition at line 600 of file param.py.

References pscfpp.param.Array.getString(), pscfpp.param.Composite.getString(), pscfpp.param.Matrix.getString(), and pscfpp.param.Parameter.getString().

Referenced by pscfpp.field.Field.write(), pscfpp.output.State.write(), and pscfpp.output.Thermo.write().

◆ getString()

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

Indented string representation of this Array object.

This function returns the string representation for this Array object in a multi-line indented parameter file format with control over indentation of the first line. The parameter 'depth' is a string of spaces that is the indentation of the first line, is prepended to every succeding line.

Parameters

depth string of spaces prefixed to all lines

Definition at line 614 of file param.py.

References pscfpp.command.Command.label, pscfpp.param.Array.label, pscfpp.param.Composite.label, pscfpp.param.Matrix.label, pscfpp.param.Parameter.label, Util::ArrayParam< Type >.label(), Util::MatrixParam< Type >.label(), Util::Parameter.label(), Util::XmlAttribute.label(), Util::XmlEndTag.label(), Util::XmlStartTag.label(), pscfpp.param.Array.val, pscfpp.param.Matrix.val, and pscfpp.param.Parameter.val.