PSCF v1.2
Pscf::Rpc::IteratorFactory< D > Class Template Reference

Factory for subclasses of Iterator. More...

#include <IteratorFactory.h>

Inheritance diagram for Pscf::Rpc::IteratorFactory< D >:
Util::Factory< Iterator< D > >

Public Member Functions

 IteratorFactory (System< D > &system)
 Constructor.
 
Iterator< D > * factory (const std::string &className) const
 Method to create any Iterator supplied with PSCF.
 
- Public Member Functions inherited from Util::Factory< Iterator< D > >
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
void addSubfactory (Factory< Iterator< D > > &subfactory)
 Add a new subfactory to the list.
 
Iterator< D > * readObject (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd, bool isRequired=true)
 Read a class name, instantiate an object, and read its parameters.
 
Iterator< D > * readObjectOptional (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd)
 Read an optional class name, instantiate an object, and read its parameters.
 
Iterator< D > * loadObject (Serializable::IArchive &ar, ParamComposite &parent, std::string &className)
 Load a class name, instantiate an object, and load the object.
 

Additional Inherited Members

- Protected Member Functions inherited from Util::Factory< Iterator< D > >
Iterator< D > * trySubfactories (const std::string &className) const
 Search through subfactories for match.
 
void setIoCommunicator (MPI::Intracomm &communicator)
 Set associated Mpi communicator.
 
bool hasIoCommunicator () const
 Does this factory have a param communicator?
 

Detailed Description

template<int D>
class Pscf::Rpc::IteratorFactory< D >

Factory for subclasses of Iterator.

Definition at line 35 of file rpc/System.h.

Constructor & Destructor Documentation

◆ IteratorFactory()

template<int D>
Pscf::Rpc::IteratorFactory< D >::IteratorFactory ( System< D > & system)

Constructor.

Definition at line 18 of file rpc/scft/iterator/IteratorFactory.tpp.

Member Function Documentation

◆ factory()

template<int D>
Iterator< D > * Pscf::Rpc::IteratorFactory< D >::factory ( const std::string & className) const
virtual

Method to create any Iterator supplied with PSCF.

Parameters
classNamename of the Iterator subclass
Returns
Iterator* pointer to new instance of className

Implements Util::Factory< Iterator< D > >.

Definition at line 26 of file rpc/scft/iterator/IteratorFactory.tpp.


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