CuboidGridObjectPopulation Class Reference

SpatialSimObjectPopulation class with SimObject's on an integer grid in 3D. More...

#include <CuboidGridObjectPopulation.h>

Inheritance diagram for CuboidGridObjectPopulation:

[legend]

Collaboration diagram for CuboidGridObjectPopulation:

[legend]

List of all members.

Public Types
enum	CoordinateIndex { X = 0, Y = 1, Z = 2 }
Public Member Functions
	CuboidGridObjectPopulation (SimNetwork &net, GridPoint3D origin, Volume3DSize dims, SimObjectFactory &objFactory)
	CuboidGridObjectPopulation (SimNetwork &net, GridPoint3D origin, Volume3DSize dims, SimObject::ID::Vector vec)
GridPoint3D &	getOrigin ()
virtual Point3D< double >	getLocation (size_t index) const
	Returns the location of the object which has a specific index in the population.
GridPoint3D	getRelativeLocation (size_t idx) const
SimObject::ID	operator() (int x, int y, int z) const
SimObject::ID	operator() (const GridPoint3D &loc) const
int	getIndex (int x, int y, int z) const
int	getIndex (const GridPoint3D &loc) const
SimObject::ID	operator() (int idx) const
SimObject::ID	atRelative (int x, int y, int z) const
SimObject::ID	at (int x, int y, int z) const
CuboidGridObjectPopulation	subVolume (int origX, int origY, int origZ, int Xdim, int Ydim, int Zdim) const
CuboidGridObjectPopulation	subVolume (const GridPoint3D &origin, const Volume3DSize &size) const
const Volume3DSize &	getDimensions () const
Protected Attributes
GridPoint3D	origin
Volume3DSize	dim

---

Detailed Description

SpatialSimObjectPopulation class with SimObject's on an integer grid in 3D.

Deprecated:

Use SpatialSimObjectPopulation with CuboidIntegerGrid3D as point set instead.

Definition at line 19 of file CuboidGridObjectPopulation.h.

---

Member Enumeration Documentation

enum CuboidGridObjectPopulation::CoordinateIndex

Enumerator:

X
Y
Z

Definition at line 22 of file CuboidGridObjectPopulation.h.

---

Constructor & Destructor Documentation

CuboidGridObjectPopulation::CuboidGridObjectPopulation	(	SimNetwork &	net,
		GridPoint3D	origin,
		Volume3DSize	dims,
		SimObjectFactory &	objFactory
	)

Definition at line 14 of file CuboidGridObjectPopulation.cpp.

Referenced by subVolume().

CuboidGridObjectPopulation::CuboidGridObjectPopulation	(	SimNetwork &	net,
		GridPoint3D	origin,
		Volume3DSize	dims,
		SimObject::ID::Vector	vec
	)

Definition at line 19 of file CuboidGridObjectPopulation.cpp.

---

Member Function Documentation

GridPoint3D& CuboidGridObjectPopulation::getOrigin

(

)

[inline]

Definition at line 28 of file CuboidGridObjectPopulation.h.

References origin.

virtual Point3D<double> CuboidGridObjectPopulation::getLocation

(

size_t

index

)

const [inline, virtual]

Returns the location of the object which has a specific index in the population.

Reimplemented from SpatialSimObjectPopulation.

Definition at line 34 of file CuboidGridObjectPopulation.h.

References getRelativeLocation(), origin, Point3D< T >::x(), Point3D< T >::y(), and Point3D< T >::z().

Here is the call graph for this function:

GridPoint3D CuboidGridObjectPopulation::getRelativeLocation

(

size_t

idx

)

const [inline]

Definition at line 39 of file CuboidGridObjectPopulation.h.

References dim, Y, and Z.

Referenced by getLocation().

SimObject::ID CuboidGridObjectPopulation::operator()	(	int	x,
		int	y,
		int	z
	)			const [inline]

Definition at line 45 of file CuboidGridObjectPopulation.h.

References dim, Y, and Z.

SimObject::ID CuboidGridObjectPopulation::operator()

(

const GridPoint3D &

loc

)

const [inline]

Definition at line 49 of file CuboidGridObjectPopulation.h.

References dim, Point3D< T >::x(), Point3D< T >::y(), Y, Point3D< T >::z(), and Z.

Here is the call graph for this function:

int CuboidGridObjectPopulation::getIndex	(	int	x,
		int	y,
		int	z
	)			const [inline]

Definition at line 53 of file CuboidGridObjectPopulation.h.

References dim, Y, and Z.

int CuboidGridObjectPopulation::getIndex

(

const GridPoint3D &

loc

)

const [inline]

Definition at line 57 of file CuboidGridObjectPopulation.h.

References dim, Point3D< T >::x(), Point3D< T >::y(), Y, Point3D< T >::z(), and Z.

Here is the call graph for this function:

SimObject::ID CuboidGridObjectPopulation::operator()

(

int

idx

)

const [inline]

Reimplemented from SimObjectPopulation.

Definition at line 61 of file CuboidGridObjectPopulation.h.

SimObject::ID CuboidGridObjectPopulation::atRelative	(	int	x,
		int	y,
		int	z
	)			const [inline]

Definition at line 65 of file CuboidGridObjectPopulation.h.

References dim, Y, and Z.

SimObject::ID CuboidGridObjectPopulation::at	(	int	x,
		int	y,
		int	z
	)			const [inline]

Definition at line 69 of file CuboidGridObjectPopulation.h.

References origin, Point3D< T >::x(), Point3D< T >::y(), and Point3D< T >::z().

Here is the call graph for this function:

CuboidGridObjectPopulation CuboidGridObjectPopulation::subVolume	(	int	origX,
		int	origY,
		int	origZ,
		int	Xdim,
		int	Ydim,
		int	Zdim
	)			const

Definition at line 24 of file CuboidGridObjectPopulation.cpp.

References CuboidGridObjectPopulation(), dim, SimObjectPopulation::net, origin, SimObjectPopulation::size(), Y, and Z.

Here is the call graph for this function:

CuboidGridObjectPopulation CuboidGridObjectPopulation::subVolume	(	const GridPoint3D &	origin,
		const Volume3DSize &	size
	)			const

Definition at line 40 of file CuboidGridObjectPopulation.cpp.

References CuboidGridObjectPopulation(), dim, SimObjectPopulation::net, origin, Point3D< T >::x(), X, Point3D< T >::y(), Y, Point3D< T >::z(), and Z.

Here is the call graph for this function:

const Volume3DSize& CuboidGridObjectPopulation::getDimensions

(

)

const [inline]

Definition at line 78 of file CuboidGridObjectPopulation.h.

References dim.

---

Member Data Documentation

GridPoint3D CuboidGridObjectPopulation::origin [protected]

Definition at line 84 of file CuboidGridObjectPopulation.h.

Referenced by at(), getLocation(), getOrigin(), and subVolume().

Volume3DSize CuboidGridObjectPopulation::dim [protected]

Definition at line 85 of file CuboidGridObjectPopulation.h.

Referenced by atRelative(), getDimensions(), getIndex(), getRelativeLocation(), operator()(), and subVolume().

---

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

• /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/CuboidGridObjectPopulation.h
• /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/CuboidGridObjectPopulation.cpp