SpatialFamilyIDGenerator Class Reference

Base class for generating several different families of objects (created by different factories) into one population. More...

#include <SpatialFamilyIDGenerator.h>

Inheritance diagram for SpatialFamilyIDGenerator:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 SpatialFamilyIDGenerator ()
 Initialize a SpatialFamilyIDGenerator.
virtual ~SpatialFamilyIDGenerator ()
 Destruct me.
virtual shared_ptr< vector
< familyid_t > > 
generateIDs (SimNetwork &net, vector< SimObjectFactory * > const &families, Point3DSet const &locs) const
 Specifiy the families. A family is defined by its associated SimObjectFactory.


Detailed Description

Base class for generating several different families of objects (created by different factories) into one population.

This is an abstract class to be extended for implementation of merging several different families of objects (created by different factories) into one population. One simple implementation for combining objects generated from several factories in one population is to specify probability of occuring for each family.

Definition at line 33 of file SpatialFamilyIDGenerator.h.


Constructor & Destructor Documentation

SpatialFamilyIDGenerator::SpatialFamilyIDGenerator (  )  [inline]

Initialize a SpatialFamilyIDGenerator.

Definition at line 37 of file SpatialFamilyIDGenerator.h.

virtual SpatialFamilyIDGenerator::~SpatialFamilyIDGenerator (  )  [inline, virtual]

Destruct me.

Definition at line 42 of file SpatialFamilyIDGenerator.h.


Member Function Documentation

virtual shared_ptr< vector<familyid_t> > SpatialFamilyIDGenerator::generateIDs ( SimNetwork net,
vector< SimObjectFactory * > const &  families,
Point3DSet const &  locs 
) const [inline, virtual]

Specifiy the families. A family is defined by its associated SimObjectFactory.

Return for each location a family id

Reimplemented in RatioBasedFamilies.

Definition at line 53 of file SpatialFamilyIDGenerator.h.

Referenced by AugmentedSpatialPopulation::AugmentedSpatialPopulation(), and SpatialFamilyPopulation::SpatialFamilyPopulation().


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

Generated on Wed Jul 9 16:34:54 2008 for PCSIM by  doxygen 1.5.5