Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

CdbPartition Class Reference

The transient interface to a partition object. More...

#include <CdbPartition.hh>

List of all members.

Public Member Functions

const CdbDatabasePtr & parent () const
 Return a smart pointer to the parent condition object.

unsigned short id () const
 The identifier of the partition.

unsigned short ownerId () const
 The identifier of the partition's owner.

std::string ownerName () const
 The name of the partition's owner.

std::string description () const
 The name of the partition's owner.

BdbTime created () const
 The creation time of the partition.

BdbTime beginValidity () const
 The begin time in the "validity" dimension.

BdbTime endValidity () const
 The end time in the "validity" dimension.

BdbTime beginInsertion () const
 The begin time in the "insertion" dimension.

virtual BdbTime endInsertion () const=0
 The begin time in the "insertion" dimension.

virtual BdbTime modified () const=0
 The recent modification time of the partition.

virtual bool isClosed () const=0
 The status of the partition.

virtual bool isInstantiated () const=0
 The status of the partition.


Protected Member Functions

 CdbPartition (const CdbDatabasePtr &theDatabasePtr, unsigned short theId, unsigned short theOwnerId, const char *theOwnerName, const char *theDescription, const BdbTime &theCreationTime, const BdbTime &theBeginValidity, const BdbTime &theEndValidity, const BdbTime &theBeginInsertion)
 The normal constructor.

virtual ~CdbPartition ()
 The destructor.


Friends

class CdbCPtrBase< CdbPartition >

Detailed Description

The transient interface to a partition object.

More details to come...

Definition at line 19 of file CdbPartition.hh.

Constructor & Destructor Documentation

CdbPartition::CdbPartition (  const CdbDatabasePtr &    theDatabasePtr,
unsigned short    theId,
unsigned short    theOwnerId,
const char *    theOwnerName,
const char *    theDescription,
const BdbTime &    theCreationTime,
const BdbTime &    theBeginValidity,
const BdbTime &    theEndValidity,
const BdbTime &    theBeginInsertion
)  [protected]
 

The normal constructor.

Initialize context with specified "stable" parameters (those ones that could not be changed during the life time of the partition.). The "dynamic" parameters of the partition are available through the virtual methods.

Parameters:
theDatabasePtr  the smart pointer providing a back back link to the parent database object
theId  the partition identifier
theOwnerId  the owner origin of the partiton
theOwnerName  the owner origin of the partiton
theDescription  the description of the partition
theCreationTime  the creation time
theBeginValidity  where the "validity" interval begins
theEndValidity  where the "validity" interval std::ends
theBeginInsertion  where the "insertion" interval begins

Definition at line 16 of file CdbPartition.cc.

CdbPartition::~CdbPartition (    )  [protected, virtual]
 

The destructor.

More details...

Definition at line 36 of file CdbPartition.cc.

Member Function Documentation

BdbTime CdbPartition::beginInsertion (    )  const
 

The begin time in the "insertion" dimension.

Definition at line 89 of file CdbPartition.cc.

BdbTime CdbPartition::beginValidity (    )  const
 

The begin time in the "validity" dimension.

Definition at line 77 of file CdbPartition.cc.

BdbTime CdbPartition::created (    )  const
 

The creation time of the partition.

Definition at line 71 of file CdbPartition.cc.

std::string CdbPartition::description (    )  const
 

The name of the partition's owner.

Definition at line 64 of file CdbPartition.cc.

virtual BdbTime CdbPartition::endInsertion (    )  const [pure virtual]
 

The begin time in the "insertion" dimension.

BdbTime CdbPartition::endValidity (    )  const
 

The end time in the "validity" dimension.

Definition at line 83 of file CdbPartition.cc.

unsigned short CdbPartition::id (    )  const
 

The identifier of the partition.

Definition at line 46 of file CdbPartition.cc.

virtual bool CdbPartition::isClosed (    )  const [pure virtual]
 

The status of the partition.

The partiton is "closed" if it's not allowed for writing into it even by its owner origin. Normally a partition gets into this state when a new one is created above it in the "insertion" time dimension. Eeffectively a "closed" partition becomes the read-only one.

virtual bool CdbPartition::isInstantiated (    )  const [pure virtual]
 

The status of the partition.

The partiton can only be "instantiated" by its owner origin to allow writing into or reading from it. Non-ownes of a partition are not allowed to read from a partition untill it gets "instantiated" by the owner and shipped to a local origin (database).

virtual BdbTime CdbPartition::modified (    )  const [pure virtual]
 

The recent modification time of the partition.

This time is increased when any of partitionable conditions are updated (new objects are written, new revisions get created) within the validity/insertion time limits of the partition. Only "open" partitions can be updated.

unsigned short CdbPartition::ownerId (    )  const
 

The identifier of the partition's owner.

Definition at line 52 of file CdbPartition.cc.

std::string CdbPartition::ownerName (    )  const
 

The name of the partition's owner.

Definition at line 58 of file CdbPartition.cc.

const CdbDatabasePtr & CdbPartition::parent (    )  const
 

Return a smart pointer to the parent condition object.

See also:
CdbCondition

CdbConditionPtr

Definition at line 40 of file CdbPartition.cc.

Friends And Related Function Documentation

friend class CdbCPtrBase< CdbPartition > [friend]
 

Definition at line 21 of file CdbPartition.hh.

The documentation for this class was generated from the following files:
Generated on Mon Dec 5 18:22:23 2005 for CDB by doxygen1.3-rc3