osaTimeServer.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s): Peter Kazanzides
  Created on: 2008-12-30

  (C) Copyright 2008-2011 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


#ifndef _osaTimeServer_h
#define _osaTimeServer_h

#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnClassRegister.h>

// Always include last
#include <cisstOSAbstraction/osaExport.h>

// PKAZ: move this to osaGetTime.h
struct CISST_EXPORT osaAbsoluteTime {
    long sec;   // seconds
    long nsec;  // nano-seconds

    osaAbsoluteTime() : sec(0L), nsec(0L) {}
    osaAbsoluteTime(long seconds, long nanoseconds) : sec(seconds), nsec(nanoseconds) {}
    ~osaAbsoluteTime() {}

    double ToSeconds(void) const;

    void FromSeconds(double timeInSeconds);
};


class CISST_EXPORT osaTimeServer: public cmnGenericObject
{
    CMN_DECLARE_SERVICES(CMN_NO_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);

    friend class osaTimeServerTest;

    enum {INTERNALS_SIZE = 32};
    char Internals[INTERNALS_SIZE];

    static unsigned int SizeOfInternals(void);

    void Synchronize(void);

public:
    osaTimeServer();
    ~osaTimeServer();

    void SetTimeOrigin(void);

    void SetTimeOriginFrom(const osaTimeServer *other);

    bool GetTimeOrigin(osaAbsoluteTime & origin) const;

    double GetRelativeTime(void) const;

    double GetAbsoluteTimeInSeconds(void) const;

    osaAbsoluteTime GetAbsoluteTime(void) const;

    double EstimateDrift(void) const;

    void RelativeToAbsolute(double relative, osaAbsoluteTime & absolute) const;

    double AbsoluteToRelative(const osaAbsoluteTime & absolute) const;
};


CMN_DECLARE_SERVICES_INSTANTIATION(osaTimeServer)


#endif // _osaTimeServer_h