Main Page   Class Hierarchy   Compound List   File List   Compound Members  

Fragment Class Reference

#include <Fragment.h>

List of all members.

Public Methods

 Fragment (void)
virtual ~Fragment ()
void initialise (void)
void incrementOccurenceCount (void)
void decreaseOccurenceCount (void)
void resetOccurenceCount (void)
int getFragmentId (void) const
void setFragmentId (int p_id)
std::string getReferenceFragmentId (void) const
void setReferenceFragmentId (std::string p_id)
const std::vector< double > & getProperties (void) const
unsigned int getNbrProperties (void) const
void setProperties (std::vector< double > &p_properties)
void addProperty (double p_property)
std::string getLibraryName (void) const
void setLibraryName (std::string p_Name)
unsigned long int getOccurenceCount (void) const
void addGoodness (const float p_goodness)
float getGoodness (void) const
void resetGoodness (void)


Detailed Description

A Fragment is an element forming the combinatorial composite. In a combinatorial library it would be related to a reagent.


Constructor & Destructor Documentation

Fragment::Fragment (  void    ) 
 

Default Constructor.

virtual Fragment::~Fragment (    )  [inline, virtual]
 

Destructor


Member Function Documentation

void Fragment::addGoodness (  const float    p_goodness )  [inline]
 

Instead of integer counter, this class allow to use floating point goodness. Each time this method is called, the internal goodness is added to the parameter passed.

void Fragment::addProperty (  double    p_property )  [inline]
 

Instead of creating the list in one shot (like setProperties method), it allows to add one by one a property. This method does not clear the intermal property list.

void Fragment::decreaseOccurenceCount (  void    )  [inline]
 

Decrease by one the internal counter.

int Fragment::getFragmentId (  void    )  const [inline]
 

Getter method for an integer Id.

float Fragment::getGoodness (  void    )  const [inline]
 

Returns the goodness.

std::string Fragment::getLibraryName (  void    )  const [inline]
 

Returns the Library Name to which this fragment object can be associated for a bidirectional associative relationship.

unsigned int Fragment::getNbrProperties (  void    )  const [inline]
 

Returns the number of properties attached to this fragment. This is the size of the property list returned by the method getProperties()

unsigned long int Fragment::getOccurenceCount (  void    )  const [inline]
 

Returns the internal counter value.

const std::vector<double>& Fragment::getProperties (  void    )  const [inline]
 

Returns the list of properties associated to this fragment.

std::string Fragment::getReferenceFragmentId (  void    )  const [inline]
 

Getter for a text based Id.

void Fragment::incrementOccurenceCount (  void    )  [inline]
 

Increment by one the internal counter. It can be used to count the number of times a reagent is part of a 'good' product.

void Fragment::initialise (  void    ) 
 

Initialise the state of the object.

void Fragment::resetGoodness (  void    )  [inline]
 

Reset to 0.0 the internal goodness.

void Fragment::resetOccurenceCount (  void    )  [inline]
 

Reset to zero the internal counter.

void Fragment::setFragmentId (  int    p_id )  [inline]
 

Setter method for an integer Id.

void Fragment::setLibraryName (  std::string    p_Name )  [inline]
 

Set the Library name (linked to Library class) to which this fragment object can be associated for a bidirectional associative relationship.

void Fragment::setProperties (  std::vector< double > &    p_properties )  [inline]
 

Clear the internal property list and reassign it to the list given as parameter.

void Fragment::setReferenceFragmentId (  std::string    p_id )  [inline]
 

Setter for a text based Id.


The documentation for this class was generated from the following file:
Generated on Sat Nov 4 15:58:59 2006 for GLARE by doxygen1.2.18