Chemical Data Processing Library C++ API - Version 1.1.1
Classes | Public Types | Public Member Functions | List of all members
CDPL::Shape::GaussianShape Class Reference

A data type for the descripton of arbitrary shapes composed of spheres approximated by gaussian functions. More...

#include <GaussianShape.hpp>

+ Inheritance diagram for CDPL::Shape::GaussianShape:

Classes

class  Element
 

Public Types

typedef std::shared_ptr< GaussianShapeSharedPointer
 
typedef ElementList::const_iterator ConstElementIterator
 
typedef ElementList::iterator ElementIterator
 
- 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

void clear ()
 
std::size_t getNumElements () const
 
void addElement (const Math::Vector3D &pos, double radius, std::size_t color=0, double hardness=2.7)
 
void addElement (const Element &elem)
 
void removeElement (std::size_t idx)
 
const ElementgetElement (std::size_t idx) const
 
ElementgetElement (std::size_t idx)
 
ConstElementIterator getElementsBegin () const
 
ConstElementIterator getElementsEnd () const
 
ElementIterator getElementsBegin ()
 
ElementIterator getElementsEnd ()
 
ConstElementIterator begin () const
 
ConstElementIterator end () const
 
ElementIterator begin ()
 
ElementIterator end ()
 
- 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...
 

Additional Inherited Members

- 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

A data type for the descripton of arbitrary shapes composed of spheres approximated by gaussian functions.

Member Typedef Documentation

◆ SharedPointer

◆ ConstElementIterator

typedef ElementList::const_iterator CDPL::Shape::GaussianShape::ConstElementIterator

◆ ElementIterator

typedef ElementList::iterator CDPL::Shape::GaussianShape::ElementIterator

Member Function Documentation

◆ clear()

void CDPL::Shape::GaussianShape::clear ( )

◆ getNumElements()

std::size_t CDPL::Shape::GaussianShape::getNumElements ( ) const

◆ addElement() [1/2]

void CDPL::Shape::GaussianShape::addElement ( const Math::Vector3D pos,
double  radius,
std::size_t  color = 0,
double  hardness = 2.7 
)

◆ addElement() [2/2]

void CDPL::Shape::GaussianShape::addElement ( const Element elem)

◆ removeElement()

void CDPL::Shape::GaussianShape::removeElement ( std::size_t  idx)

◆ getElement() [1/2]

const Element& CDPL::Shape::GaussianShape::getElement ( std::size_t  idx) const

◆ getElement() [2/2]

Element& CDPL::Shape::GaussianShape::getElement ( std::size_t  idx)

◆ getElementsBegin() [1/2]

ConstElementIterator CDPL::Shape::GaussianShape::getElementsBegin ( ) const

◆ getElementsEnd() [1/2]

ConstElementIterator CDPL::Shape::GaussianShape::getElementsEnd ( ) const

◆ getElementsBegin() [2/2]

ElementIterator CDPL::Shape::GaussianShape::getElementsBegin ( )

◆ getElementsEnd() [2/2]

ElementIterator CDPL::Shape::GaussianShape::getElementsEnd ( )

◆ begin() [1/2]

ConstElementIterator CDPL::Shape::GaussianShape::begin ( ) const

◆ end() [1/2]

ConstElementIterator CDPL::Shape::GaussianShape::end ( ) const

◆ begin() [2/2]

ElementIterator CDPL::Shape::GaussianShape::begin ( )

◆ end() [2/2]

ElementIterator CDPL::Shape::GaussianShape::end ( )

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