Show SBWObject.h syntax highlighted
/**
* @file SBWObject.h
* @brief base class for underlying API implementation classes - supports reference counting for use with SBWHandle
* @author SBW Development Group <sysbio-team@caltech.edu>
*
* Organization: Caltech ERATO Kitano Systems Biology Project
*
* Created: @date 18th June 2001
* $Id: SBWObject.h,v 1.1 2004/06/17 20:15:20 fbergmann Exp $
* $Source: /cvsroot/jdesigner/C++Broker/include/SBW/SBWObject.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_SBWOBJECT_H__C4B26DAB_0913_4AAC_9DB1_53B129F8FB46__INCLUDED_)
#define AFX_SBWOBJECT_H__C4B26DAB_0913_4AAC_9DB1_53B129F8FB46__INCLUDED_
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
#include "portableOS.h"
namespace SystemsBiologyWorkbench
{
/// base class for underlying API implementation classes - supports reference counting for use with SBWHandle
class SBWObject
{
public:
SBW_API SBWObject();
SBW_API virtual ~SBWObject() ;
// AddReference
//
// notifies _this that the caller requires _this to exist
// until the caller calls Release
// MUST BE PAIRED WITH A RELEASE CALL
// Use SBWHandle if possible instead
//
SBW_API virtual void AddReference();
// Release
//
// notifies _this that the caller doesn't require the existance
// of _this any longer following an AddReference call
// MUST BE PAIRED WITH AN ADDREFERENCE CALL
// Use SBWandle if possible instead
//
SBW_API virtual void Release();
private:
/**
* number of references 'taken out' on this object.
* Normally this is the number of SBWHandle objects refering to this object
* however some objects exposed by the C API will have an additional reference taken
* since the C API caller owns the object (but obviously not using SBWHandle).
*/
int numberOfReferences ;
};
} // SystemsBiologyWorkbench
#endif // !defined(AFX_SBWOBJECT_H__C4B26DAB_0913_4AAC_9DB1_53B129F8FB46__INCLUDED_)
See more files for this project here