---

CdbId.hh

Go to the documentation of this file.

#ifndef CDB_ID_HH
#define CDB_ID_HH

// File and Version Information:
//      $Id: CdbId.hh,v 1.6 2004/08/06 05:54:14 bartoldu Exp $

#include "CdbBase/CdbCommon.hh"

#include <iostream>

class CdbCompositeName;

/// Object of this class represent "extended" identifier for Condition/DB objects
/**
  * The "extended" object identifier defines an address of some entiry in the distributed
  * database as:
  *
  *     16-bit "origin" identifier
  *     16-bit "local" object's id in the scope of an origin
  */
class CdbId {

public:

  /// Normal & also default constructor
  /**
    */
    CdbId( unsigned short theOriginId = 0,
           unsigned short theLocalId  = 0 ) :
        origin(theOriginId),
        local(theLocalId)
    { }

  /// Copy constructor
  /**
    */
    CdbId( const CdbId& theId )
    {
        origin = theId.origin;
        local  = theId.local;
    }

  /// The destructor
  /**
    * NOTE: The destructor is NOT virtual because this is an embedded
    *       class.
    */
    ~CdbId( ) { }

  /// The assignment operator
  /**
    */
    CdbId& operator=( const CdbId& theId )
    {
        if( this != &theId ) {
            origin = theId.origin;
            local  = theId.local;
        }
        return *this;
    }

  /// The "equal" operator
  /**
    * This operator is required to insert objects of this class
    * into a B-tree.
    */
    bool operator==( const CdbId& theId ) const
    {
        return ( origin == theId.origin ) && ( local == theId.local );
    }

  /// The "not-equal" operator
  /**
    */
    bool operator!=( const CdbId& theId ) const
    {
        return ! operator==( theId );
    }

  /// The "less" operator
  /**
    * This operator is required to insert objects of this class
    * into a B-tree.
    */
    bool operator<( const CdbId& theId ) const
    {
        return ( origin < theId.origin ) || (( origin == theId.origin ) && ( local < theId.local ));
    }

public:

  /// Translate a string into an identifier
  /**
    * This utility method would attempt to translate the specified string into
    * an object of the current class. A non zero pointer onto a string is expected.
    * If the translation will be successfull then the resulting flagg would be set
    * to "true" and the reference would be properly initialized. Otherwise
    * the reference would not be affected.
    *
    * @return a boolen flag indicating the result of the translation.
    */
    static bool translate( CdbId&      theId,       /**< the reference to be initialized */
                           const char* theString    /**< the input string */
                         );

  /// Translate a 'composite name' into an identifier
  /**
    * Similarily to the above defined translation method this one would also
    * translate the specified composite name into an identifier. The composite
    * name must be 'valid'.
    *
    * @see class CdbCompositeName
    *
    * @return a boolen flag indicating the result of the translation.
    */
    static bool translate( CdbId&                  theId,           /**< the reference to be initialized */
                           const CdbCompositeName& theCompositeName /**< the input 'composite' name */
                         );

public:

    unsigned short origin;  // The identifier of an "origin"
    unsigned short local;   // The local identifier of an object in the scope of an origin
};

inline
std::ostream&
operator<<( std::ostream&     o,
            const CdbId& theId )
{
    o << theId.origin << "::" << theId.local;
    return o;
}

#endif  // CDB_ID_HH

---