SpatialSimObjectPopulation Class Reference

Population of SimObject's with associated locations in 3D space. More...

#include <SpatialSimObjectPopulation.h>

Inheritance diagram for SpatialSimObjectPopulation:

Inheritance graph
[legend]
Collaboration diagram for SpatialSimObjectPopulation:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 SpatialSimObjectPopulation (SimNetwork &net, SimObjectFactory &objFactory, shared_ptr< Point3DSet > locs)
 SpatialSimObjectPopulation (SimNetwork &net, SimObjectFactory &objFactory, size_t n)
 SpatialSimObjectPopulation (SimNetwork &net, const SimObject::ID::Vector v)
 SpatialSimObjectPopulation (SimNetwork &net, vector< SimObject::ID::Packed > const &v)
 SpatialSimObjectPopulation (SimNetwork &net, vector< SimObject::ID::Packed > const &v, shared_ptr< Point3DSet > locs)
 ~SpatialSimObjectPopulation ()
SimObject::ID getIdAt (Point3D< double > const &p)
 Returns the ID of the object at location Point3D.
SimObject::ID getIdAt (double const &x, double const &y, double const &z)
 Returns the ID of the object at location (x,y,z).
SimObjectobjectAt (Point3D< double > const &p)
 Returns a handle of the actual SimObject at location Point3D.
SimObjectobjectAt (double const &x, double const &y, double const &z)
 Returns a handle of the actual SimObject at location (x,y,z).
virtual Point3D< doublegetLocation (size_t index) const
 Returns the location of the object which has a specific index in the population.
virtual shared_ptr
< SpatialSimObjectPopulation
subPopulation (SubSpaceConstraint const &cnstr)
 Creates a new SpatialSimObjectPopulation defined by the sub-space constraint.

Protected Member Functions

 SpatialSimObjectPopulation ()
 Invoked only by derived classes.
 SpatialSimObjectPopulation (SimNetwork &net)
 Invoked only by derived classes.
 SpatialSimObjectPopulation (SimNetwork &net, shared_ptr< Point3DSet > locs)
 Invoked only by derived classes.
virtual
SpatialSimObjectPopulation
new_subset (vector< size_t > const &indices) const
 Return a new SpatialSimObjectPopulation which is a subset specified by the given set of indices.

Protected Attributes

shared_ptr< Point3DSetlocations
 Reference to the locations of objects.


Detailed Description

Population of SimObject's with associated locations in 3D space.

Definition at line 20 of file SpatialSimObjectPopulation.h.


Constructor & Destructor Documentation

SpatialSimObjectPopulation::SpatialSimObjectPopulation (  )  [inline, protected]

Invoked only by derived classes.

Definition at line 25 of file SpatialSimObjectPopulation.h.

Referenced by new_subset().

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net  )  [inline, protected]

Invoked only by derived classes.

Definition at line 29 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net,
shared_ptr< Point3DSet locs 
) [inline, protected]

Invoked only by derived classes.

Definition at line 33 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net,
SimObjectFactory objFactory,
shared_ptr< Point3DSet locs 
) [inline]

Definition at line 38 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net,
SimObjectFactory objFactory,
size_t  n 
) [inline]

Definition at line 43 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net,
const SimObject::ID::Vector  v 
) [inline]

Definition at line 48 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net,
vector< SimObject::ID::Packed > const &  v 
) [inline]

Definition at line 53 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::SpatialSimObjectPopulation ( SimNetwork net,
vector< SimObject::ID::Packed > const &  v,
shared_ptr< Point3DSet locs 
) [inline]

Definition at line 58 of file SpatialSimObjectPopulation.h.

SpatialSimObjectPopulation::~SpatialSimObjectPopulation (  ) 

Definition at line 13 of file SpatialSimObjectPopulation.cpp.


Member Function Documentation

SimObject::ID SpatialSimObjectPopulation::getIdAt ( Point3D< double > const &  p  ) 

Returns the ID of the object at location Point3D.

Definition at line 17 of file SpatialSimObjectPopulation.cpp.

References SimObjectPopulation::getID(), and locations.

Here is the call graph for this function:

SimObject::ID SpatialSimObjectPopulation::getIdAt ( double const &  x,
double const &  y,
double const &  z 
)

Returns the ID of the object at location (x,y,z).

Definition at line 21 of file SpatialSimObjectPopulation.cpp.

References SimObjectPopulation::getID(), and locations.

Here is the call graph for this function:

SimObject * SpatialSimObjectPopulation::objectAt ( Point3D< double > const &  p  ) 

Returns a handle of the actual SimObject at location Point3D.

Definition at line 25 of file SpatialSimObjectPopulation.cpp.

References locations, and SimObjectPopulation::object().

Here is the call graph for this function:

SimObject * SpatialSimObjectPopulation::objectAt ( double const &  x,
double const &  y,
double const &  z 
)

Returns a handle of the actual SimObject at location (x,y,z).

Definition at line 29 of file SpatialSimObjectPopulation.cpp.

References locations, and SimObjectPopulation::object().

Here is the call graph for this function:

Point3D< double > SpatialSimObjectPopulation::getLocation ( size_t  index  )  const [virtual]

shared_ptr< SpatialSimObjectPopulation > SpatialSimObjectPopulation::subPopulation ( SubSpaceConstraint const &  cnstr  )  [virtual]

Creates a new SpatialSimObjectPopulation defined by the sub-space constraint.

Creates a new SpatialFamilyPopulation from the objects in the population that fall within some subspace defined with a SubSpaceConstraint (What is exactly a SubSpaceConstraint can be defined later, it can be a predicate which for a given point returns true or false).

Definition at line 37 of file SpatialSimObjectPopulation.cpp.

References locations, and new_subset().

Here is the call graph for this function:

SpatialSimObjectPopulation * SpatialSimObjectPopulation::new_subset ( vector< size_t > const &  indices  )  const [protected, virtual]

Return a new SpatialSimObjectPopulation which is a subset specified by the given set of indices.

Reimplemented from SimObjectPopulation.

Reimplemented in AugmentedSpatialPopulation, and SpatialFamilyPopulation.

Definition at line 41 of file SpatialSimObjectPopulation.cpp.

References locations, SimObjectPopulation::net, and SpatialSimObjectPopulation().

Referenced by subPopulation().

Here is the call graph for this function:


Member Data Documentation


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

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