CDPL::Pharm::Feature Class Reference

Feature. More...

#include <Feature.hpp>

Inheritance diagram for CDPL::Pharm::Feature:

Public Member Functions
virtual const Pharmacophore &	getPharmacophore () const =0
	Returns a const reference to the parent pharmacophore. More...
virtual Pharmacophore &	getPharmacophore ()=0
	Returns a non-const reference to the parent pharmacophore. More...
virtual std::size_t	getIndex () const =0
	Returns the index of the feature in its parent pharmacophore. More...
Feature &	operator= (const Feature &feature)
	Assignment operator that replaces the current set of properties with the properties of feature;. More...
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 Any &	getProperty (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 PropertyContainer &	getProperties () const
	Returns a const reference to itself. More...

Protected Member Functions
virtual	~Feature ()
	Virtual destructor. More...
Protected Member Functions inherited from CDPL::Chem::Entity3D
	Entity3D ()
	Default constructor. More...
	Entity3D (const Entity3D &entity)
	Constructs a copy of the Entity3D instance entity. More...
virtual	~Entity3D ()
	Virtual destructor. More...
Entity3D &	operator= (const Entity3D &cntnr)
	Assignment operator. More...
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...
PropertyContainer &	operator= (const PropertyContainer &cntnr)
	Assignment operator. More...

Additional Inherited Members
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...

Detailed Description

Feature.

Constructor & Destructor Documentation

~Feature()

virtual CDPL::Pharm::Feature::~Feature ( )

inlineprotectedvirtual

Virtual destructor.

Member Function Documentation

getPharmacophore() [1/2]

virtual const Pharmacophore& CDPL::Pharm::Feature::getPharmacophore ( ) const

pure virtual

Returns a const reference to the parent pharmacophore.

Returns

A const reference to the parent pharmacophore.

Implemented in CDPL::Pharm::BasicFeature.

getPharmacophore() [2/2]

virtual Pharmacophore& CDPL::Pharm::Feature::getPharmacophore ( )

pure virtual

Returns a non-const reference to the parent pharmacophore.

Returns

A non-const reference to the parent pharmacophore.

Implemented in CDPL::Pharm::BasicFeature.

getIndex()

virtual std::size_t CDPL::Pharm::Feature::getIndex ( ) const

pure virtual

Returns the index of the feature in its parent pharmacophore.

Returns

The zero-based index of the feature.

Implemented in CDPL::Pharm::BasicFeature.

operator=()

Feature& CDPL::Pharm::Feature::operator=

(

const Feature &

feature

)

Assignment operator that replaces the current set of properties with the properties of feature;.

Parameters

feature

The feature whose properties get copied.

Returns

A reference to itself.

---

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

• Feature.hpp