PSCF v1.1
|
Beginning line of a composite parameter block. More...
#include <Begin.h>
Public Member Functions | |
Begin (const char *label, bool isRequired=true) | |
Constructor. More... | |
virtual void | readParam (std::istream &in) |
Read the opening line. More... | |
virtual void | writeParam (std::ostream &out) const |
Write the opening line. More... | |
bool | isRequired () const |
Is this the beginning line for a required element? More... | |
bool | isActive () const |
Is this an active element (has it been read from file)? More... | |
virtual void | resetParam () |
Do-nothing implementation of virtual resetParam function. More... | |
![]() | |
virtual | ~ParamComponent () |
Destructor. More... | |
virtual void | readParam (std::istream &in)=0 |
Read parameter(s) from file. More... | |
virtual void | writeParam (std::ostream &out) const =0 |
Read parameter(s) to file. More... | |
virtual void | load (Serializable::IArchive &ar) |
Load internal state from an archive. More... | |
virtual void | save (Serializable::OArchive &ar) |
Save internal state to an archive. More... | |
virtual void | resetParam () |
Nontrivial implementation provided by ParamComposite subclass. More... | |
void | setIndent (const ParamComponent &parent, bool next=true) |
Set indent level. More... | |
std::string | indent () const |
Return indent string for this object (string of spaces). More... | |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Serialize this ParamComponent as a string. More... | |
![]() | |
virtual | ~Serializable () |
Destructor. More... | |
virtual void | save (OArchive &ar)=0 |
Save to an archive. More... | |
virtual void | load (IArchive &ar)=0 |
Load from an archive. More... | |
![]() | |
MpiFileIo () | |
Constructor. More... | |
MpiFileIo (const MpiFileIo &other) | |
Copy constructor. More... | |
bool | isIoProcessor () const |
Can this processor do file I/O ? More... | |
void | setIoCommunicator (MPI::Intracomm &communicator) |
Set the communicator. More... | |
void | clearCommunicator () |
Clear (nullify) the communicator. More... | |
bool | hasIoCommunicator () const |
Does this object have an associated MPI communicator? More... | |
MPI::Intracomm & | ioCommunicator () const |
Get the MPI communicator by reference. More... | |
Additional Inherited Members | |
![]() | |
typedef BinaryFileOArchive | OArchive |
Type of output archive used by save method. More... | |
typedef BinaryFileIArchive | IArchive |
Type of input archive used by load method. More... | |
![]() | |
static void | initStatic () |
Initialize static echo member to false. More... | |
static void | setEcho (bool echo=true) |
Enable or disable echoing for all subclasses of ParamComponent. More... | |
static bool | echo () |
Get echo parameter. More... | |
![]() | |
ParamComponent () | |
Constructor. More... | |
ParamComponent (const ParamComponent &other) | |
Copy constructor. More... | |
Util::Begin::Begin | ( | const char * | label, |
bool | isRequired = true |
||
) |
|
virtual |
Read the opening line.
in | input stream |
Implements Util::ParamComponent.
Definition at line 33 of file Begin.cpp.
References Util::bcast< bool >(), Util::ParamComponent::echo(), Util::Log::file(), Util::MpiFileIo::hasIoCommunicator(), Util::ParamComponent::indent(), Util::MpiFileIo::ioCommunicator(), Util::Label::isClear(), Util::MpiFileIo::isIoProcessor(), isRequired(), UTIL_THROW, and writeParam().
Referenced by Util::ParamComposite::readBegin().
|
virtual |
Write the opening line.
out | output stream |
Implements Util::ParamComponent.
Definition at line 80 of file Begin.cpp.
References Util::ParamComponent::indent(), and Util::Label::string().
Referenced by Util::ParamComposite::load(), Util::Factory< Data >::readObject(), and readParam().
|
inline |
Is this the beginning line for a required element?
Definition at line 78 of file Begin.h.
References Util::Label::isRequired().
Referenced by readParam().
|
inline |
Is this an active element (has it been read from file)?
Definition at line 84 of file Begin.h.
Referenced by Util::Manager< Data >::beginReadManager(), Util::ParamComposite::readBegin(), and Util::ParamComposite::readParamOptional().
|
virtual |
Do-nothing implementation of virtual resetParam function.
Reimplemented from Util::ParamComponent.