ReplicaFiller Class Reference

#include <ReplicaFiller.h>

Inheritance diagram for ReplicaFiller:

Public Member Functions
void	readXML (XMLfileUnits &xmlconfig)
	Read in XML configuration for ReplicaFiller and all its included objects. More...
void	init ()
void	setInputReader (std::shared_ptr< InputBase > inputReader)
void	setObject (std::shared_ptr< Object > object)
std::shared_ptr< Object >	getObject ()
int	getMolecule (Molecule *molecule)
std::string	getPluginName ()

Static Public Member Functions
static ObjectFillerBase *	createInstance ()

Detailed Description

The ReplicaFiller returns molecules within an object by replicating molecules generated by another input reader / generator.

Member Function Documentation

getMolecule()

int ReplicaFiller::getMolecule ( Molecule *  molecule )

virtual

Get a single molecule By subsequent calls all molecules will be returned, one by one.

Parameters

[out]

molecule

Pointer to molecule data structure where to store the molecule data (coordinate and component id)

Returns

0 if no more molecules can be returned

Implements ObjectFillerBase.

getPluginName()

std::string ReplicaFiller::getPluginName ( )

inlinevirtual

Implements ObjectFillerBase.

init()

void ReplicaFiller::init ( )

virtual

Initialize the generator with current internal state

Implements ObjectFillerBase.

readXML()

void ReplicaFiller::readXML ( XMLfileUnits &  xmlconfig )

virtual

Read in XML configuration for ReplicaFiller and all its included objects.

The following xml object structure is handled by this method:

<filler type="ReplicaFiller">
  <input type=""><!-- See the documentation of the input reader --></input>
  <origin><x>DOUBLE</x> <y>DOUBLE</y> <z>DOUBLE</z> <!-- base point for the replication --> </origin>
</filler>

Implements ObjectFillerBase.

setObject()

void ReplicaFiller::setObject ( std::shared_ptr< Object >  object )

virtual

Implements ObjectFillerBase.

---

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

• src/utils/generator/ReplicaFiller.h
• src/utils/generator/ReplicaFiller.cpp