Electronics and Software
Engineering Innovation
Beam-lib  2.15.1

#include <BTimeStampMs.h>

Public Member Functions

 BTimeStampMs (BString str="")
 
 ~BTimeStampMs ()
 
void clear ()
 Clear the date/time. More...
 
void setNow ()
 Set the timeStamp to now. More...
 
BTimeStampMsaddMilliSeconds (int milliSeconds)
 Add the given number of milli seconds. This should be less that a year. More...
 
BTimeStampMssubMilliSeconds (int milliSeconds)
 Add the given number of milli seconds. This should be less that a year. More...
 
BTimeStampMsaddSeconds (int seconds)
 Add the given number of seconds. This should be less that a year. More...
 
BTimeStampMssubSeconds (int seconds)
 Subtract the given number of seconds. This should be less that a year. More...
 
uint32_t getYearSeconds ()
 Get number of seconds within the year. More...
 
uint64_t getYearMilliSeconds ()
 Get number of seconds within the year. More...
 
BString getString (BString separator="T")
 Get the time as an ISO date/time string. More...
 
BString getStringNoMs (BString separator="T")
 Get the time as an ISO date/time string with no ms. More...
 
BError setString (BString dateTime)
 Set the time from an ISO date/time. More...
 
BString getDurationString (BString separator="T")
 Get the time as an ISO date/time string but with month's and days starting from 0. More...
 
BString getDurationStringNoMs (BString separator="T")
 Get the time as an ISO date/time string but with month's and days starting from 0 with no ms. More...
 
BError setDurationString (BString dateTime)
 Set the time from an ISO date/time string but with month's and days starting from 0. More...
 
BString getStringRaw ()
 
void getDate (int &year, int &mon, int &day)
 Get the year, month and day. More...
 
int compare (const BTimeStampMs &timeStamp)
 Compare two dates. More...
 
int operator> (const BTimeStampMs &timeStamp)
 
int operator>= (const BTimeStampMs &timeStamp)
 
int operator< (const BTimeStampMs &timeStamp)
 
int operator<= (const BTimeStampMs &timeStamp)
 

Static Public Member Functions

static int isLeap (int year)
 
static BUInt64 difference (BTimeStampMs t2, BTimeStampMs t1)
 

Public Attributes

uint16_t year
 Year (2000 .. 3000) More...
 
uint16_t yday
 Day in year (0 .. 365) More...
 
uint16_t hour
 Hour (0 .. 23) More...
 
uint16_t minute
 Minute (0 .. 59) More...
 
uint16_t second
 Second (0 .. 59) More...
 
uint16_t milliSecond
 MilliSecond (0 .. 999) More...
 
int32_t sampleNumber
 The sample number this time refers to. More...
 

Constructor & Destructor Documentation

◆ BTimeStampMs()

BTimeStampMs::BTimeStampMs ( BString  str = "")

◆ ~BTimeStampMs()

BTimeStampMs::~BTimeStampMs ( )

Member Function Documentation

◆ addMilliSeconds()

BTimeStampMs & BTimeStampMs::addMilliSeconds ( int  milliSeconds)

Add the given number of milli seconds. This should be less that a year.

◆ addSeconds()

BTimeStampMs & BTimeStampMs::addSeconds ( int  seconds)

Add the given number of seconds. This should be less that a year.

◆ clear()

void BTimeStampMs::clear ( )

Clear the date/time.

◆ compare()

int BTimeStampMs::compare ( const BTimeStampMs timeStamp)

Compare two dates.

◆ difference()

BUInt64 BTimeStampMs::difference ( BTimeStampMs  t2,
BTimeStampMs  t1 
)
static

◆ getDate()

void BTimeStampMs::getDate ( int &  year,
int &  mon,
int &  day 
)

Get the year, month and day.

◆ getDurationString()

BString BTimeStampMs::getDurationString ( BString  separator = "T")

Get the time as an ISO date/time string but with month's and days starting from 0.

◆ getDurationStringNoMs()

BString BTimeStampMs::getDurationStringNoMs ( BString  separator = "T")

Get the time as an ISO date/time string but with month's and days starting from 0 with no ms.

◆ getString()

BString BTimeStampMs::getString ( BString  separator = "T")

Get the time as an ISO date/time string.

◆ getStringNoMs()

BString BTimeStampMs::getStringNoMs ( BString  separator = "T")

Get the time as an ISO date/time string with no ms.

◆ getStringRaw()

BString BTimeStampMs::getStringRaw ( )

◆ getYearMilliSeconds()

uint64_t BTimeStampMs::getYearMilliSeconds ( )

Get number of seconds within the year.

◆ getYearSeconds()

uint32_t BTimeStampMs::getYearSeconds ( )

Get number of seconds within the year.

◆ isLeap()

int BTimeStampMs::isLeap ( int  year)
static

◆ operator<()

int BTimeStampMs::operator< ( const BTimeStampMs timeStamp)
inline

◆ operator<=()

int BTimeStampMs::operator<= ( const BTimeStampMs timeStamp)
inline

◆ operator>()

int BTimeStampMs::operator> ( const BTimeStampMs timeStamp)
inline

◆ operator>=()

int BTimeStampMs::operator>= ( const BTimeStampMs timeStamp)
inline

◆ setDurationString()

BError BTimeStampMs::setDurationString ( BString  dateTime)

Set the time from an ISO date/time string but with month's and days starting from 0.

◆ setNow()

void BTimeStampMs::setNow ( )

Set the timeStamp to now.

◆ setString()

BError BTimeStampMs::setString ( BString  dateTime)

Set the time from an ISO date/time.

◆ subMilliSeconds()

BTimeStampMs & BTimeStampMs::subMilliSeconds ( int  milliSeconds)

Add the given number of milli seconds. This should be less that a year.

◆ subSeconds()

BTimeStampMs & BTimeStampMs::subSeconds ( int  seconds)

Subtract the given number of seconds. This should be less that a year.

Member Data Documentation

◆ hour

uint16_t BTimeStampMs::hour

Hour (0 .. 23)

◆ milliSecond

uint16_t BTimeStampMs::milliSecond

MilliSecond (0 .. 999)

◆ minute

uint16_t BTimeStampMs::minute

Minute (0 .. 59)

◆ sampleNumber

int32_t BTimeStampMs::sampleNumber

The sample number this time refers to.

◆ second

uint16_t BTimeStampMs::second

Second (0 .. 59)

◆ yday

uint16_t BTimeStampMs::yday

Day in year (0 .. 365)

◆ year

uint16_t BTimeStampMs::year

Year (2000 .. 3000)


The documentation for this class was generated from the following files: