Time.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Time class header file
 
Author: Alex Reynolds
*/
#ifndef ARCHITECTURE_TIME_H
#define ARCHITECTURE_TIME_H
 
#include "configuration.h"
 
#include <time.h>
#if CLOCKWERK_ALLOW_STD_STRING
#include <string>
#endif
 
#include "architecture/GraphTreeObject.h"
#include "logging/SimLogger.h"

#define NSEC_MAX 999999999
 
namespace clockwerk {
    const floating_point NSEC_PER_SEC_D = 1000000000.0;
    const uint16 MSEC_PER_SEC_I = 1000;
    const uint32 NSEC_PER_MSEC_I = 1000000;
    const uint32 NSEC_PER_SEC_I = 1000000000;

    //
    class Time : public GraphTreeObject {
    public:
        Time(const struct timespec &t) {_tspec = t; _loggable=true;}
        Time(int64 sec=0, int64 nsec=0) {_tspec.tv_sec=sec; _tspec.tv_nsec=nsec; _loggable=true;}
        ~Time() {};

        int64 sec() const {return _tspec.tv_sec;}
        int64 nsec() const {return _tspec.tv_nsec;}

        void setTime(const struct timespec &t) {_tspec = t;}

        void setTime(uint32 sec, uint32 nsec) {_tspec.tv_sec=sec; _tspec.tv_nsec=nsec;}

        void stepTime(uint64 nsec);

        const timespec& asTimespec() const {return _tspec;}
        floating_point asFloatingPoint() const {return (floating_point)_tspec.tv_sec + ((floating_point)_tspec.tv_nsec)/NSEC_PER_SEC_D;}
        unsigned long long asMilliseconds() const {return _tspec.tv_sec*MSEC_PER_SEC_I + _tspec.tv_nsec/NSEC_PER_MSEC_I;}
 
        int16 fromStr(const char* str) override;

        int16 str(char* output, size_t size) const override;
 
#if CLOCKWERK_ALLOW_STD_STRING
#if CLOCKWERK_ALLOW_VECTOR
        int16 log(void* logger) {
            SimLogger* log_ptr = (SimLogger*)logger;
            log_ptr->writeToBuffer(asFloatingPoint());
            return NO_ERROR;
        }

        std::vector<std::string> header_info() const {
            return {""};
        }
#endif
#endif

        floating_point asFrequency();

        int16 fromFrequency(uint16 rate_hz);
        void fromFloatingPoint(floating_point val);

        int16 add(const Time &a, Time &res) const;

        int16 subtract(const Time &b, Time &res) const;

        int16 multiply(unsigned int m, Time &res) const;

        int16 divide(unsigned int d, Time &res) const;

        bool operator>=(const Time& B) const;

        bool operator<=(const Time& B) const;

        bool operator>(const Time& B) const;

        bool operator<(const Time& B) const;

        bool operator==(const Time& B) const;
    protected:
        struct timespec _tspec;
    };
 
}
 
#endif