Chemical Data Processing Library C++ API - Version 1.1.1
Public Types | Public Member Functions | Protected Member Functions | List of all members
CDPL::Grid::SpatialGrid< T, CVT > Class Template Referenceabstract

SpatialGrid. More...

#include <SpatialGrid.hpp>

+ Inheritance diagram for CDPL::Grid::SpatialGrid< T, CVT >:

Public Types

typedef std::shared_ptr< SpatialGridSharedPointer
 
typedef T ValueType
 
typedef CVT CoordinatesValueType
 
typedef Math::CVector< CVT, 3 > CoordinatesType
 
- Public Types inherited from CDPL::Grid::AttributedGrid
typedef std::shared_ptr< AttributedGridSharedPointer
 
- Public Types inherited from CDPL::Base::PropertyContainer
typedef PropertyMap::value_type PropertyEntry
 A Base::LookupKey / Base::Any pair that stores the property value for a given property key. More...
 
typedef PropertyMap::const_iterator ConstPropertyIterator
 A constant iterator used to iterate over the property entries. More...
 

Public Member Functions

virtual ValueTypeoperator() (std::size_t i)=0
 
virtual const ValueTypeoperator() (std::size_t i) const =0
 
virtual void getCoordinates (std::size_t i, CoordinatesType &coords) const =0
 
- Public Member Functions inherited from CDPL::Grid::AttributedGrid
virtual ~AttributedGrid ()
 
virtual std::size_t getNumElements () const =0
 
virtual bool isEmpty () const =0
 
- Public Member Functions inherited from CDPL::Base::PropertyContainer
std::size_t getNumProperties () const
 Returns the number of property entries. More...
 
template<typename T >
void setProperty (const LookupKey &key, T &&val)
 Sets the value of the property specified by key to val. More...
 
template<typename T >
const T & getProperty (const LookupKey &key) const
 Returns the value of the property specified by key as a const reference to an object of type T. More...
 
template<typename T >
const T & getPropertyOrDefault (const LookupKey &key, const T &def_val) const
 Returns the value of the property specified by key as a const reference to an object of type T, or the default value def_val if a stored value does not exist. More...
 
const AnygetProperty (const LookupKey &key, bool throw_=false) const
 Returns the value of the property specified by key. More...
 
bool isPropertySet (const LookupKey &key) const
 Tells whether or not a value has been assigned to the property specified by key. More...
 
ConstPropertyIterator getPropertiesBegin () const
 Returns a constant iterator pointing to the beginning of the property entries. More...
 
ConstPropertyIterator getPropertiesEnd () const
 Returns a constant iterator pointing to the end of the property entries. More...
 
ConstPropertyIterator begin () const
 Returns a constant iterator pointing to the beginning of the property entries. More...
 
ConstPropertyIterator end () const
 Returns a constant iterator pointing to the end of the property entries. More...
 
bool removeProperty (const LookupKey &key)
 Clears the value of the property specified by key. More...
 
void clearProperties ()
 Clears all property values. More...
 
void addProperties (const PropertyContainer &cntnr)
 Adds the property value entries in the PropertyContainer instance cntnr. More...
 
void copyProperties (const PropertyContainer &cntnr)
 Replaces the current set of properties by a copy of the entries in cntnr. More...
 
void swap (PropertyContainer &cntnr)
 Exchanges the properties of this container with the properties of the container cntnr. More...
 
const PropertyContainergetProperties () const
 Returns a const reference to itself. More...
 

Protected Member Functions

SpatialGridoperator= (const SpatialGrid &grid)
 
- Protected Member Functions inherited from CDPL::Grid::AttributedGrid
AttributedGridoperator= (const AttributedGrid &grid)
 
- Protected Member Functions inherited from CDPL::Base::PropertyContainer
 PropertyContainer ()
 Constructs an empty PropertyContainer instance. More...
 
 PropertyContainer (const PropertyContainer &cntnr)
 Constructs a copy of the PropertyContainer instance cntnr. More...
 
virtual ~PropertyContainer ()
 Virtual destructor. More...
 
PropertyContaineroperator= (const PropertyContainer &cntnr)
 Assignment operator. More...
 

Detailed Description

template<typename T, typename CVT = T>
class CDPL::Grid::SpatialGrid< T, CVT >

SpatialGrid.

Member Typedef Documentation

◆ SharedPointer

template<typename T , typename CVT = T>
typedef std::shared_ptr<SpatialGrid> CDPL::Grid::SpatialGrid< T, CVT >::SharedPointer

◆ ValueType

template<typename T , typename CVT = T>
typedef T CDPL::Grid::SpatialGrid< T, CVT >::ValueType

◆ CoordinatesValueType

template<typename T , typename CVT = T>
typedef CVT CDPL::Grid::SpatialGrid< T, CVT >::CoordinatesValueType

◆ CoordinatesType

template<typename T , typename CVT = T>
typedef Math::CVector<CVT, 3> CDPL::Grid::SpatialGrid< T, CVT >::CoordinatesType

Member Function Documentation

◆ operator()() [1/2]

template<typename T , typename CVT = T>
virtual ValueType& CDPL::Grid::SpatialGrid< T, CVT >::operator() ( std::size_t  i)
pure virtual

◆ operator()() [2/2]

template<typename T , typename CVT = T>
virtual const ValueType& CDPL::Grid::SpatialGrid< T, CVT >::operator() ( std::size_t  i) const
pure virtual

◆ getCoordinates()

template<typename T , typename CVT = T>
virtual void CDPL::Grid::SpatialGrid< T, CVT >::getCoordinates ( std::size_t  i,
CoordinatesType coords 
) const
pure virtual

◆ operator=()

template<typename T , typename CVT = T>
SpatialGrid& CDPL::Grid::SpatialGrid< T, CVT >::operator= ( const SpatialGrid< T, CVT > &  grid)
inlineprotected

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