Last change
on this file since 4379 was
4321,
checked in by patrick, 19 years ago
|
orxonox/trunk: added doxygen tags for the baseobject class
|
File size:
969 bytes
|
Line | |
---|
1 | /*! |
---|
2 | \file proto_class.h |
---|
3 | \brief Definition of the proto class template, used quickly start work |
---|
4 | */ |
---|
5 | |
---|
6 | |
---|
7 | #ifndef _BASE_OBJECT_H |
---|
8 | #define _BASE_OBJECT_H |
---|
9 | |
---|
10 | #include "stdincl.h" |
---|
11 | #include "class_list.h" |
---|
12 | |
---|
13 | class BaseObject { |
---|
14 | |
---|
15 | public: |
---|
16 | BaseObject (); |
---|
17 | virtual ~BaseObject (); |
---|
18 | |
---|
19 | void setClassID(int id); |
---|
20 | void setClassName(const char* className); |
---|
21 | void setClassID(int id, const char* className); |
---|
22 | |
---|
23 | inline const char* getClassName(void) const { return this->className;}; |
---|
24 | inline int getClassID(void) const { return this->id; } |
---|
25 | bool isA (char* className); |
---|
26 | |
---|
27 | inline bool isFinalized() { return this->finalized; } |
---|
28 | void finalize(); |
---|
29 | |
---|
30 | private: |
---|
31 | const char* className; //!< the name of the class |
---|
32 | int id; //!< this is the id from the class_list.h enumeration |
---|
33 | bool finalized; //!< is true if the object is ready to be garbage collected |
---|
34 | }; |
---|
35 | |
---|
36 | #endif /* _BASE_OBJECT_H */ |
---|
Note: See
TracBrowser
for help on using the repository browser.