Chemical Data Processing Library C++ API - Version 1.1.1
Public Member Functions | Friends | List of all members
CDPL::Pharm::BasicFeature Class Reference

BasicFeature. More...

#include <BasicFeature.hpp>

+ Inheritance diagram for CDPL::Pharm::BasicFeature:

Public Member Functions

const PharmacophoregetPharmacophore () const
 Returns a const reference to the parent pharmacophore. More...
 
PharmacophoregetPharmacophore ()
 Returns a non-const reference to the parent pharmacophore. More...
 
std::size_t getIndex () const
 Returns the index of the feature in its parent pharmacophore. More...
 
BasicFeatureoperator= (const BasicFeature &feature)
 Assignment operator that replaces the current set of properties with the properties of feature;. More...
 
Featureoperator= (const Feature &feature)
 Assignment operator that replaces the current set of properties with the properties of feature;. More...
 
- Public Member Functions inherited from CDPL::Pharm::Feature
Featureoperator= (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 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...
 

Friends

class BasicPharmacophore
 

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...
 
- Protected Member Functions inherited from CDPL::Pharm::Feature
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...
 
Entity3Doperator= (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...
 
PropertyContaineroperator= (const PropertyContainer &cntnr)
 Assignment operator. More...
 

Detailed Description

BasicFeature.

Member Function Documentation

◆ getPharmacophore() [1/2]

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

Returns a const reference to the parent pharmacophore.

Returns
A const reference to the parent pharmacophore.

Implements CDPL::Pharm::Feature.

◆ getPharmacophore() [2/2]

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

Returns a non-const reference to the parent pharmacophore.

Returns
A non-const reference to the parent pharmacophore.

Implements CDPL::Pharm::Feature.

◆ getIndex()

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

Returns the index of the feature in its parent pharmacophore.

Returns
The zero-based index of the feature.

Implements CDPL::Pharm::Feature.

◆ operator=() [1/2]

BasicFeature& CDPL::Pharm::BasicFeature::operator= ( const BasicFeature feature)

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

Parameters
featureThe feature whose properties get copied.
Returns
A reference to itself.

◆ operator=() [2/2]

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

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

Parameters
featureThe feature whose properties get copied.
Returns
A reference to itself.

Friends And Related Function Documentation

◆ BasicPharmacophore

friend class BasicPharmacophore
friend

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