---

CdbTimeUtils.hh

Go to the documentation of this file.

#ifndef CDB_TIME_UTILS_HH
#define CDB_TIME_UTILS_HH

// File and Version Information:
//      $Id: CdbTimeUtils.hh,v 1.4 2005/10/25 17:25:29 gapon Exp $

#include "CdbBase/CdbCommon.hh"

#include "BdbTime/BdbTime.hh"

#include <string>

/// A utility class for manipulations with objects of the BdbTime class
/**
  * This is a collection of most common operations with BdbTime done in
  * in the context of CDB API, its implementations, and its clients.
  */
class CdbTimeUtils {

public:

  /// Translate a string into an object of BdbTime
  /**
    * This utility method would attempt to translate the specified string into
    * an object of the BdbTime class if this is possible. A non zero pointer onto
    * a string is expected.
    *
    * NOTE; Unlike the standard method of translating time available through
    *
    *         BdbTime::parseTime()
    *
    *       the current one will also recognize an internal numeric format of time.
    *
    * If the translation will be successfull then the resulting flag 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 string2time( BdbTime&    theTime,   /**< the value to be initialized */
                             const char* theString  /**< the input string */
                           );

  /// Translate a string into an object of BdbTime
  /**
    * A variation of the above explained method.
    */
    static bool string2time( BdbTime&           theTime,
                             const std::string& theString
                           );

  /// Translate an object of BdbTime into a string
  /**
    * The method would return a string with an internal representation of time:
    *
    *    <seconds>.<nanoseconds>
    *
    * The only exception of this rule is for the value of BdbTime::minusInfinity and
    * BdbTime::plusInfinity. By default they would be printed as:
    *
    *   "       -Infinity       "
    *   "       +Infinity       "
    *
    * unless an optional flag "forceInternalFormat" is set to "true".
    *
    * By default the resulting string will be of afixed length: 11+1+11=23 characters
    * unless an optional flag "packedFormat" is set to "true".
    *
    * @return a string representation of the input object.
    */
    static std::string time2string( const BdbTime& theTime,                     /**< the input object to be translated */
                                    bool           forceInternalFormat = false, /**< the format control flag for "infinity" values */
                                    bool           packedFormat        = false  /**< the format control flag */
                                  );

  /// Translate an object of BdbTime into a string
  /**
    * The method would return a string with an internal representation of time
    * followed by its human readable string:
    *
    *    3123456789.0987654321 : Wed 15 Jan 2005 10:11:00 (local timezone) 0 ns
    *
    * @see CdbTimeUtils::time2string()
    */
    static std::string time2string2( const BdbTime& theTime,                        /**< the input object to be translated */
                                     BdbTime::Zone  theTimeZone = BdbTime::Local,   /**< the way we're interpreting the time */
                                     bool           forceInternalFormat = false,    /**< the format control flag for "infinity" values */
                                     bool           packedFormat        = false     /**< the format control flag */
                                   );
  /// Get the current timestamp
  /**
    * This utility function would produce a string with the current timestamp
    * in the following format:
    *
    *   monthDay_hour::minute::sec.milisec
    */
    static std::string get_current_timestamp( );

  /// Translate a 64-bit number of nanoseconds into an object of BdbTime
  /**
    * A number on the input is supposed to be a previously packed value of
    * a BdbTime object.
    *
    * The overflow is returned as BdbTime::plusInfinity
    */
    static BdbTime from_nsec( unsigned long long theNumber );

  /// Translate an object of BdbTime class into a 64-bit number of nanoseconds
  /**
    * A number on the input is supposed to be a previously packed value of
    * a BdbTime object.
    */
    static unsigned long long to_nsec( const BdbTime& theTime );
};

#endif  // CDB_TIME_UTILS_HH

---