Module pypcsim :: Class CuboidGridObjectPopulation

Class CuboidGridObjectPopulation

        object --+            
                 |            
       ??.instance --+        
                     |        
   SimObjectPopulation --+    
                         |    
SpatialSimObjectPopulation --+
                             |
                            CuboidGridObjectPopulation

Help on CuboidGridObjectPopulation [class]: SpatialSimObjectPopulation class with SimObject's on an integer grid in 3D

\deprecated Use SpatialSimObjectPopulation with CuboidIntegerGrid3D as point set instead.

Nested Classes

[hide private]

CoordinateIndex

Instance Methods

[hide private]

__call__(...)
Help on SimObject::ID CuboidGridObjectPopulation::operator()(int x, int y, int z) const [member operator]

__init__(...)
Help on CuboidGridObjectPopulation::CuboidGridObjectPopulation(SimNetwork & net, GridPoint3D origin, Volume3DSize dims, SimObjectFactory & objFactory) [constructor]

at(...)
Help on SimObject::ID CuboidGridObjectPopulation::at(int x, int y, int z) const [member function]

atRelative(...)
Help on SimObject::ID CuboidGridObjectPopulation::atRelative(int x, int y, int z) const [member function]

getDimensions(...)
Help on Volume3DSize const & CuboidGridObjectPopulation::getDimensions() const [member function]

getIndex(...)
Help on int CuboidGridObjectPopulation::getIndex(int x, int y, int z) const [member function]

getLocation(...)

getOrigin(...)
Help on GridPoint3D & CuboidGridObjectPopulation::getOrigin() [member function]

getRelativeLocation(...)
Help on GridPoint3D CuboidGridObjectPopulation::getRelativeLocation(size_t idx) const [member function]

subVolume(...)
Help on CuboidGridObjectPopulation CuboidGridObjectPopulation::subVolume(int origX, int origY, int origZ, int Xdim, int Ydim, int Zdim) const [member function]

Inherited from SpatialSimObjectPopulation: getIdAt, objectAt, subPopulation

Inherited from SimObjectPopulation: __getitem__, getID, getNet, idVector, localIndexes, localSubPopulation, object, record, setFieldScale, size, subset

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

X = pypcsim.CoordinateIndex.X

Y = pypcsim.CoordinateIndex.Y

Z = pypcsim.CoordinateIndex.Z

__instance_size__ = 68

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

call(...)
(Call operator)

Help on SimObject::ID CuboidGridObjectPopulation::operator()(int x, int y, int z) const [member operator]

Help on SimObject::ID CuboidGridObjectPopulation::operator()(GridPoint3D const & loc) const [member operator]

Help on SimObject::ID CuboidGridObjectPopulation::operator()(int idx) const [member operator]

Overrides: SimObjectPopulation.__call__

init(...)
(Constructor)

Help on CuboidGridObjectPopulation::CuboidGridObjectPopulation(SimNetwork & net, GridPoint3D origin, Volume3DSize dims, SimObjectFactory & objFactory) [constructor]

Help on CuboidGridObjectPopulation::CuboidGridObjectPopulation(SimNetwork & net, GridPoint3D origin, Volume3DSize dims, boost::shared_ptr<std::vector<long long, std::allocator<long long> > > vec) [constructor]

Overrides: object.__init__

getIndex(...)

Help on int CuboidGridObjectPopulation::getIndex(int x, int y, int z) const [member function]

Help on int CuboidGridObjectPopulation::getIndex(GridPoint3D const & loc) const [member function]

getLocation(...)

Overrides: SpatialSimObjectPopulation.getLocation

subVolume(...)

Help on CuboidGridObjectPopulation CuboidGridObjectPopulation::subVolume(int origX, int origY, int origZ, int Xdim, int Ydim, int Zdim) const [member function]

Help on CuboidGridObjectPopulation CuboidGridObjectPopulation::subVolume(GridPoint3D const & origin, Volume3DSize const & size) const [member function]

Class CuboidGridObjectPopulation

__call__(...) (Call operator)

__init__(...) (Constructor)

getIndex(...)

getLocation(...)

subVolume(...)

call(...)
(Call operator)

init(...)
(Constructor)