#include <CdbOrigin.hh>
Public Member Functions | |
| const CdbDatabasePtr & | parent () const |
| Return a smart pointer to the parent database object. | |
| const char * | name () const |
| The name of an object. | |
| virtual BdbTime | created ()=0 |
| Obtain the creation time of the origin. | |
| virtual std::string | description ()=0 |
| Obtain the origin description. | |
| unsigned short | id () const |
| The identifier of an object. | |
| virtual bool | isLocal () const=0 |
| Check if this origin is the local one. | |
| virtual bool | isInstantiated () const=0 |
| Check if data corresponding to this origin are available in the local database. | |
| virtual bool | isMaster () const=0 |
| Check if this origin is the "master" one. | |
| virtual bool | isSlave () const=0 |
| Check if this origin is a "slave" one. | |
| virtual bool | isTest () const=0 |
| Check if this origin is a "test" one. | |
| virtual CdbStatus | propertyIterator (CdbItr< CdbProperty > &theItr)=0 |
| Set up an iterator of properties. | |
Static Public Member Functions | |
| CdbStatus | instance (CdbOriginPtr &theOriginPtr, const char *theOriginName, const char *theDatabaseName=0, const char *theImplementationName=0, const char *theTechnologyName=0) |
| The static locator for an origin object (by name). | |
| CdbStatus | instance (CdbOriginPtr &theOriginPtr, unsigned short theOriginId, const char *theDatabaseName=0, const char *theImplementationName=0, const char *theTechnologyName=0) |
| The static locator for an origin object (by id). | |
Protected Member Functions | |
| CdbOrigin (const CdbDatabasePtr &theDatabasePtr, const char *theName, unsigned short theId) | |
| The normal constructor. | |
| virtual | ~CdbOrigin () |
| The destructor. | |
Friends | |
| class | CdbCPtrBase< CdbOrigin > |
More details to come...
Definition at line 23 of file CdbOrigin.hh.
|
||||||||||||||||
|
The normal constructor. Initialize context with specified parameters.
Definition at line 86 of file CdbOrigin.cc. |
|
|
The destructor. More details... Definition at line 94 of file CdbOrigin.cc. |
|
|
Obtain the creation time of the origin. This method is supposed to be implemented by the corresponding subclass.
|
|
|
Obtain the origin description. This method is supposed to be implemented by the corresponding subclass.
|
|
|
The identifier of an object.
Definition at line 110 of file CdbOrigin.cc. |
|
||||||||||||||||||||||||
|
The static locator for an origin object (by id). This locator is similar to teh one defined above. It just uses an identifier instead of a name.
Definition at line 52 of file CdbOrigin.cc. References CdbStatus::Error, CdbDatabase::instance(), and CdbStatus::Success. |
|
||||||||||||||||||||||||
|
The static locator for an origin object (by name). This locator uses the name of the origin to resolve the right instance of the origin object in the scope of a database. The database itself as well as the top-level API object are two optional parameters of this method. If either (or both) of them are not specified then the corresponding default values will be used.
Definition at line 17 of file CdbOrigin.cc. References CdbStatus::Error, CdbDatabase::instance(), and CdbStatus::Success. |
|
|
Check if data corresponding to this origin are available in the local database. The positive answer means that the data from remote database have already been brought into local database. This method is supposed to be implementyed by subclasses.
|
|
|
Check if this origin is the local one. The "local" origin is the one corresponding to the part of a distributed database setup currently being used by a client application. This database also can be called the "local" one. Depending on the origin's type "local" databases (=origins) may have persistent resources modifiable by clients' applications. The actual set on those resources depends on the origin's type. This method is supposed to be implementyed by subclasses.
|
|
|
Check if this origin is the "master" one. The "master" origin is meant to describe the central database of a distributed database setup. Certain database operations can only be performed in this central "master" database. This method is supposed to be implemented by subclasses.
|
|
|
Check if this origin is a "slave" one. The "slave" origin is meant to describe a database being a part of a distributed database setup. The database of the "slave" origin is allowed to contribute data into the distrubuted database so that these data can be seen and used by clients of other databases of the setup. The "slave" origin is known to its central "master" database. The "master" may delegate certain operations to its "slave"-s. This method is supposed to be implemented by subclasses.
|
|
|
Check if this origin is a "test" one. The "test" origin is meant to describe a database NOT being a part of a distributed database setup. The database of the "test" origin is NOT allowed to contribute data into the distrubuted database in a way it's done by "slave" databases. However the "test" type databases are allowed to produce their own local data to be consumed locally. It's allso allowed to import data from the corresponding distributed database. This method is supposed to be implemented by subclasses.
|
|
|
The name of an object.
Definition at line 104 of file CdbOrigin.cc. |
|
|
Return a smart pointer to the parent database object.
Definition at line 98 of file CdbOrigin.cc. |
|
|
Set up an iterator of properties. Specific implementations of this origin class my supply technology- and implementation- specific properties. This method is supposed to be implemented by subclasses.
|
|
|
Definition at line 25 of file CdbOrigin.hh. |
1.3-rc3