biofunction.h

/**************************************************************************
 * Copyright (c) 2004-2011 T. M. Murali                                   *
 * Copyright (c) 2007-2011 Naveed Massjouni                               *
 * Copyright (c) 2009-2011 Christopher L. Poirel                          *
 * Copyright (c) 2011 Phillip Whisenhunt                                  *
 * Copyright (c) 2011 David Badger                                        *
 * Copyright (c) 2010 Clifford Conley Owens III                           *
 *                                                                        *
 * This file is part of Biorithm.                                         *
 *                                                                        *
 * Biorithm is free software: you can redistribute it and/or modify       *
 * it under the terms of the GNU General Public License as published by   *
 * the Free Software Foundation, either version 3 of the License, or      *
 * (at your option) any later version.                                    *
 *                                                                        *
 * Biorithm is distributed in the hope that it will be useful,            *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 * GNU General Public License for more details.                           *
 *                                                                        *
 * You should have received a copy of the GNU General Public License      *
 * along with Biorithm.  If not, see <http://www.gnu.org/licenses/>.      *
 *                                                                        *
 **************************************************************************/

// Purpose: a barebones class that specifies a function by id and
// category. I call this file biofunction.h to distinguish it from
// function.h in the C++ standard library.

#ifndef _BIOFUNCTION_H
#define _BIOFUNCTION_H

#include <string>
using namespace std;


// with so many strings floating around, it is better to define such a
// type. i use it in active-networks.h.
typedef string BioFunctionCategoryType;

class BioFunction
{
protected:
  string _category;
  string _id;
  string _name;
public:
  BioFunction()
      : _category(), _id(), _name()
    {}

  BioFunction(string cat, string id, string name = "")
      : _category(cat), _id(id), _name(name)
    {}
  BioFunction(const BioFunction& other)
      : _category(other._category), _id(other._id), _name(other._name)
    {}
  
  virtual ~BioFunction()
    {}

  virtual string getCategory() const
    {
      return(_category);
    }
  virtual string getId() const
    {
      return(_id);
    }
  
  virtual string getName() const
    {
      return(_name);
    }

  bool operator==(const BioFunction &other) const
    {
      return((_category == other._category) && (_id == other._id));
    }
  
  bool operator!=(const BioFunction &other) const
    {
      return(!(*this == other));
    }
  bool operator<(const BioFunction &rhs) const
    {
      if (getCategory() == rhs.getCategory())
        return(getId() < rhs.getId());
      return((getCategory() < rhs.getCategory()));
    }
  
};
  
inline ostream &operator<<(ostream &ostr, const BioFunction &function)
{
  ostr << function.getId();
  if ("" != function.getName())
    ostr << ": " << function.getName();
  ostr << " (" << function.getCategory() << ") ";
  return(ostr);
}



#endif // _BIOFUNCTION_H