- Add some comments

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@1266 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
tchernobog 2006-09-17 22:22:18 +00:00
parent 581477fa70
commit a37be5231b
2 changed files with 15 additions and 1 deletions

View File

@ -155,7 +155,6 @@ namespace sgpem
-# Via command line arguments -# Via command line arguments
-# By a backend::Plugin::on_init() method called when loading an external DSO. This is perfectly normal and permitted. -# By a backend::Plugin::on_init() method called when loading an external DSO. This is perfectly normal and permitted.
*/ */
int _speed; int _speed;
}; };
} }

View File

@ -29,16 +29,31 @@ namespace sgpem
class Resource; class Resource;
class SerializeVisitor; class SerializeVisitor;
/** \brief An abstract class representing a resource
*
* A resource in a real operating system could be a printer,
* a socket, a chunk of memory, or a simple file.
*/
class SG_DLLEXPORT Resource class SG_DLLEXPORT Resource
{ {
public: public:
virtual ~Resource(); virtual ~Resource();
/** \brief See if two different states point to the same resource */
virtual bool operator==(const Resource& op2) const = 0; virtual bool operator==(const Resource& op2) const = 0;
/** \brief Returns the resource name */
virtual Glib::ustring get_name() const = 0; virtual Glib::ustring get_name() const = 0;
/** \brief Return the number of places this resource has available
* before becoming unavailable
*
* E.g. if a resource has two places, it can fulfill only two
* ::SubRequests at each instant
*/
virtual unsigned int get_places() const = 0; virtual unsigned int get_places() const = 0;
/** \brief Used to serialize the informations of this entity */
virtual void serialize(SerializeVisitor& translator) const = 0; virtual void serialize(SerializeVisitor& translator) const = 0;
}; };