flatlogs::timespecX Struct Reference

A fixed-width timespec structure. More...

#include <timespecX.hpp>

Collaboration diagram for flatlogs::timespecX:

Public Member Functions
timespecX &	operator= (const timespec &ts)
	Convert a native timespec to a timespecX. More...
timespec	getTimespec ()
	Get a native timespec from this custom one. More...
template<clockid_t clk_id = CLOCK_REALTIME>
void	gettime ()
	Fill the the timespecX with the current time. More...
int	timeStamp (std::string &tstamp)
	Get the filename timestamp for this timespecX. More...
std::string	timeStamp ()
	Get the filname timestamp for this timespecX. More...
std::string	ISO8601DateTimeStrX ()
	Get a date-time string in ISO 8601 format for timespecX. More...

Public Attributes
secT	time_s
	Time since the Unix epoch. More...
nanosecT	time_ns
	Nanoseconds. More...

Detailed Description

A fixed-width timespec structure.

To ensure that binary encoding of time is stable regardless of environment, we use a custom timespec composed of fixed-width types.

Note

This is NOT binary compatible with plain timespec. Use the provided conversions.

Definition at line 31 of file timespecX.hpp.

Member Function Documentation

gettime()

template<clockid_t clk_id = CLOCK_REALTIME>

void flatlogs::timespecX::gettime ( )

inline

Fill the the timespecX with the current time.

This is based on the usual clock_gettime. clockid_t is a template parameter since we probaby always want CLOCK_REALTIME, but if we don't for some reason it will be passed in the same order as in clock_gettime.

Template Parameters

clk_id

specifies the type.

Definition at line 76 of file timespecX.hpp.

Referenced by flatlogs::clock_gettimeX(), and MagAOX::logger::logManager< logFileT >::createLog().

getTimespec()

timespec flatlogs::timespecX::getTimespec ( )

inline

Get a native timespec from this custom one.

Definition at line 58 of file timespecX.hpp.

ISO8601DateTimeStrX()

std::string flatlogs::timespecX::ISO8601DateTimeStrX ( )

inline

Get a date-time string in ISO 8601 format for timespecX.

Returns a string in the ISO 8601 format:

YYYY-MM-DDTHH:MM:SS.SSSSSSSSS

Return values

std::string

containing the formated date/time

Definition at line 135 of file timespecX.hpp.

Referenced by flatlogs::stdFormat().

operator=()

timespecX& flatlogs::timespecX::operator= ( const timespec &  ts )

inline

Convert a native timespec to a timespecX.

Returns

this reference, if values are 0 and 0 then the input was too big or negative.

Todo:

make this use minval and maxval

Parameters

[in]

ts

the native timespec from which to get values

Definition at line 41 of file timespecX.hpp.

timeStamp() [1/2]

int flatlogs::timespecX::timeStamp ( std::string &  tstamp )

inline

Get the filename timestamp for this timespecX.

Fills in a string with the timestamp encoded as

YYYYMMDDHHMMSSNNNNNNNNN

Parameters

[out]

tstamp

the string to hold the formatted time

Definition at line 90 of file timespecX.hpp.

Referenced by MagAOX::logger::logFileRaw::createFile().

timeStamp() [2/2]

std::string flatlogs::timespecX::timeStamp ( )

inline

Get the filname timestamp for this timespecX.

Returns a string with the timestamp encoded as

YYYYMMDDHHMMSSNNNNNNNNN

Definition at line 118 of file timespecX.hpp.

Member Data Documentation

time_ns

nanosecT flatlogs::timespecX::time_ns

Nanoseconds.

Definition at line 34 of file timespecX.hpp.

Referenced by getTimespec(), and flatlogs::timespecFromX().

time_s

secT flatlogs::timespecX::time_s

Time since the Unix epoch.

Definition at line 33 of file timespecX.hpp.

Referenced by getTimespec(), ISO8601DateTimeStrX(), flatlogs::timespecFromX(), and timeStamp().

---

The documentation for this struct was generated from the following file:

• /home/jrmales/Source/MagAOX/flatlogs/include/flatlogs/timespecX.hpp