Bdb packages | Design docs | Source docs | Guidelines | Recent releases
| |
|
|
Bdb packages | Design docs | Source docs | Guidelines | Recent releases |
|
Main Page Modules Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members CdbStateControl Class Reference
The state control interface for the API classes. More...
[CdbBase]
#include <CdbStateControl.hh>
Inheritance diagram for CdbStateControl:
List of all members.
Public Methods
virtual bool isValid ()=0 Check if the current API context is valid. virtual bool isOpen ()=0 Check if the current API component is open. virtual CdbStatus open ()=0 Open the component. virtual CdbStatus close ()=0 Close the component. Protected Methods
virtual ~CdbStateControl () The destructor. Detailed Description
The state control interface for the API classes.This interface incorporates external controls for the API components, whose instances maintain dynamic relaishionship with the corresponding persistent entities.
In the current design of the API only the following groups of controls are defined:
- the one providing opening, closing and enquiering the current state of a connection with the corresponding persistent entity.
- the one providing the "validity" of an interface's instance. Here the idea is that at some point of time an API component may become "invalid" (which means non-usable in given context) even if this component was created "valid" at the beginning.
Definition at line 24 of file CdbStateControl.hh.
Constructor & Destructor Documentation
CdbStateControl::~CdbStateControl ( ) [protected, virtual]
The destructor.
Is only available for the derived classes and friends to prevent accidental deletion of objects.
Definition at line 10 of file CdbStateControl.cc.
Member Function Documentation
virtual CdbStatus CdbStateControl::close ( ) [pure virtual]
Close the component.
Drop the open onnection with the corresponding persistent entity.
- See also:
- CdbStatus
- Returns:
- the completion status
Implemented in CdbBdbSCondition, CdbBdbSDatabase, CdbBdbSFolder, CdbBdbSView, CdbBdbWCondition, CdbBdbWDatabase, CdbBdbWFolder, and CdbBdbWView.
virtual bool CdbStateControl::isOpen ( ) [pure virtual]
Check if the current API component is open.
This flag makes a sense only if the database is "valid". It's role is to indicate if the current API component has established reliable and consistent communication with the corresponding persistent entity.
- Returns:
- true if the component is open
Implemented in CdbBdbSCondition, CdbBdbSDatabase, CdbBdbSFolder, CdbBdbSView, CdbBdbWCondition, CdbBdbWDatabase, CdbBdbWFolder, and CdbBdbWView.
virtual bool CdbStateControl::isValid ( ) [pure virtual]
Check if the current API context is valid.
The precise definition of the "valid" depends on an API component implementing this interface. However the general assumption is that it is "usable" to communicate with the corresponding persistent counterpart.
- Returns:
- true if a component is valid
Implemented in CdbBdbSCondition, CdbBdbSDatabase, CdbBdbSFolder, CdbBdbSView, CdbBdbWCondition, CdbBdbWDatabase, CdbBdbWFolder, and CdbBdbWView.
virtual CdbStatus CdbStateControl::open ( ) [pure virtual]
Open the component.
This will connect the API component with the corresponding persistent entity.
- See also:
- CdbStatus
- Returns:
- the completion status
Implemented in CdbBdbSCondition, CdbBdbSDatabase, CdbBdbSFolder, CdbBdbSView, CdbBdbWCondition, CdbBdbWDatabase, CdbBdbWFolder, and CdbBdbWView.
The documentation for this class was generated from the following files:
- /CdbBase/CdbStateControl.hh
- /CdbBase/CdbStateControl.cc
BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us
Page Owner: Jacek Becla
Last Update: October 04, 2002
