PSCF v1.3
Pscf::R1d::IteratorFactory Class Reference

Factory for subclasses of Iterator. More...

#include <IteratorFactory.h>

Inheritance diagram for Pscf::R1d::IteratorFactory:
Util::Factory< Iterator >

Public Member Functions

 IteratorFactory (System &system)
 Constructor.
Iteratorfactory (const std::string &className) const
 Method to create any Iterator supplied with PSCF.
Public Member Functions inherited from Util::Factory< Iterator >
 Factory ()
 Constructor.
virtual ~Factory ()
 Destructor.
void addSubfactory (Factory< Iterator > &subfactory)
 Add a new subfactory to the list.
Iterator * 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 * readObjectOptional (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd)
 Read an optional class name, instantiate an object, and read its parameters.
Iterator * 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 >
Iterator * trySubfactories (const std::string &className) const
 Search through subfactories for match.

Detailed Description

Factory for subclasses of Iterator.

The default iterator, invoked by className Iterator, is the Anderson mixing iterator (className AmIterator).

Definition at line 30 of file r1d/iterator/IteratorFactory.h.

Constructor & Destructor Documentation

◆ IteratorFactory()

Pscf::R1d::IteratorFactory::IteratorFactory ( System & system)

Constructor.

Parameters
systemparent System object

Definition at line 16 of file r1d/iterator/IteratorFactory.cpp.

Member Function Documentation

◆ factory()

Iterator * Pscf::R1d::IteratorFactory::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 >.

Definition at line 23 of file r1d/iterator/IteratorFactory.cpp.

References Util::Factory< Iterator >::trySubfactories().


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