Util::FSArrayParam< Type, Capacity > Class Template Reference

A Parameter associated with a FSArray container. More...

#include <FSArrayParam.h>

Inheritance diagram for Util::FSArrayParam< Type, Capacity >:

Public Member Functions
	FSArrayParam (const char *label, FSArray< Type, Capacity > &array, int n, bool isRequired=true)
	Constructor.
void	writeParam (std::ostream &out) const
	Write parameter to stream.
Public Member Functions inherited from Util::ArrayParam< Type >
	ArrayParam (const char *label, int n, bool isRequired=true)
	Constructor.
virtual	~ArrayParam ()
	Destructor.
int	n () const
	Get the logical array dimension.
std::string	indent () const
	Return indent string for this object (string of spaces).
virtual void	load (Serializable::IArchive &ar)
	Load from an archive.
virtual void	save (Serializable::OArchive &ar)
	Save to an archive.
std::string	label () const
	Return label string.
bool	isRequired () const
	Is this an optional parameter?
bool	isActive () const
	Is this parameter active?
Public Member Functions inherited from Util::Parameter
	Parameter (const char *label, bool isRequired=true)
	Constructor.
virtual	~Parameter ()
	Destructor.
virtual void	readParam (std::istream &in)
	Read a label and (if the label matches) a parameter value.
std::string	label () const
	Return label string.
bool	isRequired () const
	Is this an optional parameter?
bool	isActive () const
	Is this parameter active?
Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor.
virtual void	resetParam ()
	Nontrivial implementation provided by ParamComposite subclass.
void	setIndent (const ParamComponent &parent, bool next=true)
	Set indent level.
std::string	indent () const
	Return indent string for this object (string of spaces).
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	Serialize this ParamComponent as a string.
Public Member Functions inherited from Util::Serializable
virtual	~Serializable ()
	Destructor.
Public Member Functions inherited from Util::MpiFileIo
	MpiFileIo ()
	Constructor.
	MpiFileIo (const MpiFileIo &other)
	Copy constructor.
bool	isIoProcessor () const
	Can this processor do file I/O ?
void	setIoCommunicator (MPI::Intracomm &communicator)
	Set the communicator.
void	clearCommunicator ()
	Clear (nullify) the communicator.
bool	hasIoCommunicator () const
	Does this object have an associated MPI communicator?
MPI::Intracomm &	ioCommunicator () const
	Get the MPI communicator by reference.

Protected Member Functions
Type &	element (int i)
	Return a reference to one element of the array (non-const).
Type const &	element (int i) const
	Return a reference to one element of the array (const).
virtual void	readValue (std::istream &in)
	Read parameter value from an input stream.
virtual void	loadValue (Serializable::IArchive &ar)
	Load bare parameter value from an archive.
virtual void	saveValue (Serializable::OArchive &ar)
	Save parameter value to an archive.
virtual void	bcastValue ()
	Broadcast parameter value within the ioCommunicator.
Protected Member Functions inherited from Util::ArrayParam< Type >
virtual void	readLabel (std::istream &in)
	Read parameter label from an input stream.
void	readEndBracket (std::istream &in)
	Read a closing bracket, if necessary.
bool	hasBrackets () const
	Are square brackets being used as delimiters?
Protected Member Functions inherited from Util::Parameter
Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor.
	ParamComponent (const ParamComponent &other)
	Copy constructor.

Additional Inherited Members
Public Types inherited from Util::Serializable
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method.
typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method.
Static Public Member Functions inherited from Util::Parameter
template<class Type >
static void	saveOptional (Serializable::OArchive &ar, Type &value, bool isActive)
	Save an optional parameter value to an output archive.
template<class Type >
static void	saveOptionalCArray (Serializable::OArchive &ar, Type *ptr, int n, bool isActive)
	Save an optional C-array of n values to an output archive.
template<class Type >
static void	saveOptionalCArray2D (Serializable::OArchive &ar, Type *ptr, int m, int n, int np, bool isActive)
	Save an optional two-dimensional C array to an output archive.
Static Public Member Functions inherited from Util::ParamComponent
static void	initStatic ()
	Initialize static echo member to false.
static void	setEcho (bool echo=true)
	Enable or disable echoing for all subclasses of ParamComponent.
static bool	echo ()
	Get echo parameter.
Static Public Attributes inherited from Util::Parameter
static const int	Width = 20
	Width of output field for a scalar variable.
static const int	Precision = 12
	Precision for io of floating point data field.
Protected Attributes inherited from Util::ArrayParam< Type >
Label	label_
	Label object that contains parameter label string.
Protected Attributes inherited from Util::Parameter
Label	label_
	Label object that contains parameter label string.
bool	isActive_
	Is this parameter active (always true if isRequired).

Detailed Description

template<typename Type, int Capacity>
class Util::FSArrayParam< Type, Capacity >

A Parameter associated with a FSArray container.

Definition at line 26 of file FSArrayParam.h.

Constructor & Destructor Documentation

FSArrayParam()

template<typename Type , int Capacity>

Util::FSArrayParam< Type, Capacity >::FSArrayParam	(	const char *	label,
		FSArray< Type, Capacity > &	array,
		int	n,
		bool	isRequired = true )

Constructor.

Parameters

label	label for array
array	associated FSArray<Type, Capacity> container
n	expected logical dimension (size) of array
isRequired	Is this a required parameter (true) or optional ?

Definition at line 106 of file FSArrayParam.h.

Member Function Documentation

writeParam()

template<typename Type , int Capacity>

void Util::FSArrayParam< Type, Capacity >::writeParam ( std::ostream & out ) const

virtual

Write parameter to stream.

Parameters

out	output stream

Reimplemented from Util::ArrayParam< Type >.

Definition at line 118 of file FSArrayParam.h.

References Util::Parameter::isActive(), UTIL_CHECK, and Util::ArrayParam< Type >::writeParam().

element() [1/2]

template<typename Type , int Capacity>

Type & Util::FSArrayParam< Type, Capacity >::element ( int i )

inlineprotectedvirtual

Return a reference to one element of the array (non-const).

Implements Util::ArrayParam< Type >.

Definition at line 56 of file FSArrayParam.h.

element() [2/2]

template<typename Type , int Capacity>

Type const & Util::FSArrayParam< Type, Capacity >::element ( int i ) const

inlineprotectedvirtual

Return a reference to one element of the array (const).

Implements Util::ArrayParam< Type >.

Definition at line 62 of file FSArrayParam.h.

readValue()

template<typename Type , int Capacity>

void Util::FSArrayParam< Type, Capacity >::readValue ( std::istream & in )

protectedvirtual

Read parameter value from an input stream.

Parameters

in	input stream from which to read

Reimplemented from Util::ArrayParam< Type >.

Definition at line 131 of file FSArrayParam.h.

References Util::ArrayParam< Type >::readEndBracket(), and UTIL_CHECK.

loadValue()

template<typename Type , int Capacity>

void Util::FSArrayParam< Type, Capacity >::loadValue ( Serializable::IArchive & ar )

protectedvirtual

Load bare parameter value from an archive.

Parameters

ar	input archive from which to load

Reimplemented from Util::Parameter.

Definition at line 148 of file FSArrayParam.h.

References UTIL_CHECK.

saveValue()

template<typename Type , int Capacity>

void Util::FSArrayParam< Type, Capacity >::saveValue ( Serializable::OArchive & ar )

protectedvirtual

Save parameter value to an archive.

Parameters

ar	output archive to which to save

Reimplemented from Util::Parameter.

Definition at line 158 of file FSArrayParam.h.

References UTIL_CHECK.

bcastValue()

template<typename Type , int Capacity>

void Util::FSArrayParam< Type, Capacity >::bcastValue ( )

protectedvirtual

Broadcast parameter value within the ioCommunicator.

Reimplemented from Util::Parameter.

Definition at line 169 of file FSArrayParam.h.

References Util::bcast().

---

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

• FSArrayParam.h