Show Module.h syntax highlighted
/**
* @file Module.h
* @brief represents a potentially different module
* @author SBW Development Group <sysbio-team@caltech.edu>
*
* Organization: Caltech ERATO Kitano Systems Biology Project
*
* Created: @date 18th June 2001
* $Id: Module.h,v 1.3 2005/06/22 01:57:52 fbergmann Exp $
* $Source: /cvsroot/jdesigner/C++Broker/include/SBW/Module.h,v $
*/
/*
** Copyright 2001 California Institute of Technology and
** Japan Science and Technology Corporation.
**
** This library is free software; you can redistribute it and/or modify it
** under the terms of the GNU Lesser General Public License as published
** by the Free Software Foundation; either version 2.1 of the License, or
** any later version.
**
** This library 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. The software and
** documentation provided hereunder is on an "as is" basis, and the
** California Institute of Technology and Japan Science and Technology
** Corporation have no obligations to provide maintenance, support,
** updates, enhancements or modifications. In no event shall the
** California Institute of Technology or the Japan Science and Technology
** Corporation be liable to any party for direct, indirect, special,
** incidental or consequential damages, including lost profits, arising
** out of the use of this software and its documentation, even if the
** California Institute of Technology and/or Japan Science and Technology
** Corporation have been advised of the possibility of such damage. See
** the GNU Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public License
** along with this library; if not, write to the Free Software Foundation,
** Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
**
** The original code contained here was initially developed by:
**
** Andrew Finney, Herbert Sauro, Michael Hucka, Hamid Bolouri
** The Systems Biology Workbench Development Group
** ERATO Kitano Systems Biology Project
** Control and Dynamical Systems, MC 107-81
** California Institute of Technology
** Pasadena, CA, 91125, USA
**
** http://www.cds.caltech.edu/erato
** mailto:sysbio-team@caltech.edu
**
** Contributor(s):
**
*/
/// MSVC generated include loop block
#if !defined(AFX_MODULE_H__76E98251_5D19_45CE_AA4E_2CF25048F108__INCLUDED_)
#define AFX_MODULE_H__76E98251_5D19_45CE_AA4E_2CF25048F108__INCLUDED_
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
#include "portableOS.h"
#include "Service.h"
#include "ModuleDescriptor.h"
#include "ModuleImpl.h"
namespace SystemsBiologyWorkbench
{
/// reference to a module instance
class SBW_API Module
{
public:
/// creates a potential reference to a module instance which refers to no knowm module instance.
Module() : moduleId(SBWErrorModule) {};
/// equality operator
bool operator==(Module other)
{
return moduleId == other.moduleId;
}
/// inequality operator
bool operator!=(Module other)
{
return moduleId != other.moduleId;
}
/**
* returns the numeric instance identifier of the module.
* @return the numeric instance identifier of the module.
*/
Integer getModuleInstanceId() { return moduleId ; }
std::vector<Service> *getServices();
Service findServiceByName(std::string x);
std::vector<Service> *findServicesByCategory(std::string x);
ModuleDescriptor getDescriptor();
void release();
void shutdown();
/**
* creates a reference to a module instance.
* @param id the numeric module instance identifier.
*/
Module(Integer id) : moduleId(id) {}
private:
/// the numeric module instance identifier.
Integer moduleId ;
friend class Service ;
friend class SBW ;
friend class SBWListener;
friend class ModuleImpl;
friend class SBWLowLevel;
};
} // ServiceMethod::
#endif // !defined(AFX_MODULE_H__76E98251_5D19_45CE_AA4E_2CF25048F108__INCLUDED_)
See more files for this project here