TimeStamp.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  TimeStamp.h
//
//  Cross-platform TimeStamp
//
//  Copyright (c) 2010 Mal Lansell <mal@lansell.org>
//  All rights reserved.
//
//  SOFTWARE NOTICE AND LICENSE
//
//  This file is part of OpenZWave.
//
//  OpenZWave is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  OpenZWave is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _TimeStamp_H
#define _TimeStamp_H

#include "Defs.h"

namespace OpenZWave
{
    namespace Internal
    {
        namespace Platform
        {
            class TimeStampImpl;

            class OPENZWAVE_EXPORT TimeStamp
            {
                public:
                    TimeStamp();

                    ~TimeStamp();

                    void SetTime(int32 _milliseconds = 0);

                    int32 TimeRemaining();

                    string GetAsString();

                    int32 operator-(TimeStamp const& _other);

                private:
                    TimeStamp(TimeStamp const&);                // prevent copy
                    TimeStamp& operator =(TimeStamp const&);    // prevent assignment

                    TimeStampImpl* m_pImpl;                 // Pointer to an object that encapsulates the platform-specific implementation of the TimeStamp.
            };
        } // namespace Platform
    } // namespace Internal
} // namespace OpenZWave

#endif //_TimeStamp_H