Beginning line of a composite parameter block. More...

#include <Begin.h>

Inheritance diagram for Util::Begin:

Public Member Functions
	Begin (const char *label, bool isRequired=true)
	Constructor.

virtual void	readParam (std::istream &in)
	Read the opening line.

virtual void	writeParam (std::ostream &out) const
	Write the opening line.

bool	isRequired () const
	Is this the beginning line for a required element?

bool	isActive () const
	Is this an active element (has it been read from file)?

virtual void	resetParam ()
	Do-nothing implementation of virtual resetParam function.

Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor.

virtual void	load (Serializable::IArchive &ar)
	Load internal state from an archive.

virtual void	save (Serializable::OArchive &ar)
	Save internal state to an archive.

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.

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::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.

Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor.

	ParamComponent (const ParamComponent &other)
	Copy constructor.