Public Member Functions | List of all members
FIX::UtcDate Class Reference

Date only represented in UTC. More...

#include <FieldTypes.h>

Inheritance diagram for FIX::UtcDate:
Inheritance graph
[legend]
Collaboration diagram for FIX::UtcDate:
Collaboration graph
[legend]

Public Member Functions

 UtcDate ()
 Defaults to the current date. More...
 
 UtcDate (const DateTime &val)
 
 UtcDate (int date, int month, int year)
 
 UtcDate (int sec)
 
 UtcDate (const tm *time)
 
void setCurrent ()
 Set to the current time. More...
 
- Public Member Functions inherited from FIX::DateTime
 DateTime ()
 Default constructor - initializes to zero. More...
 
 DateTime (int date, int time)
 Construct from a Julian day number and time in millis. More...
 
 DateTime (int year, int month, int day, int hour, int minute, int second, int millis)
 Construct from the specified components. More...
 
virtual ~DateTime ()
 
int getYear () const
 Return the year portion of the date. More...
 
int getMonth () const
 Return the month (1-12) portion of the date. More...
 
int getDay () const
 Return the day of the month portion of the date. More...
 
int getDate () const
 Another name for the day of the month. More...
 
int getJulianDate () const
 Return the internal julian date. More...
 
int getHour () const
 Return the hour portion of the time (0-23) More...
 
int getMinute () const
 Return the minute portion of the time (0-59) More...
 
int getSecond () const
 Return the second portion of the time (0-59) More...
 
int getMillisecond () const
 Return the millisecond portion of the time. More...
 
void getYMD (int &year, int &month, int &day) const
 Load the referenced values with the year, month and day portions of the date in a single operation. More...
 
void getHMS (int &hour, int &minute, int &second, int &millis) const
 Load the referenced values with the hour, minute, second and millisecond portions of the time in a single operation. More...
 
int getWeekDay () const
 Calculate the weekday of the date (Sunday is 1, Saturday is 7) More...
 
time_t getTimeT () const
 Convert the DateTime to a time_t. More...
 
tm getTmUtc () const
 Convert the DateTime to a struct tm which is in UTC. More...
 
void setYMD (int year, int month, int day)
 Set the date portion of the DateTime. More...
 
void setHMS (int hour, int minute, int second, int millis)
 Set the time portion of the DateTime. More...
 
void setHour (int hour)
 Set the hour portion of the time. More...
 
void setMinute (int min)
 Set the minute portion of the time. More...
 
void setSecond (int sec)
 Set the seconds portion of the time. More...
 
void setMillisecond (int millis)
 Set the millisecond portion of the time. More...
 
void clearDate ()
 Clear the date portion of the DateTime. More...
 
void clearTime ()
 Clear the time portion of the DateTime. More...
 
void set (int date, int time)
 Set the internal date and time members. More...
 
void set (const DateTime &other)
 Initialize from another DateTime. More...
 
void operator+= (int seconds)
 Add a number of seconds to this. More...
 

Additional Inherited Members

- Public Types inherited from FIX::DateTime
enum  {
  SECONDS_PER_DAY = 86400, SECONDS_PER_HOUR = 3600, SECONDS_PER_MIN = 60, MINUTES_PER_HOUR = 60,
  MILLIS_PER_DAY = 86400000, MILLIS_PER_HOUR = 3600000, MILLIS_PER_MIN = 60000, MILLIS_PER_SEC = 1000,
  JULIAN_19700101 = 2440588
}
 Magic numbers. More...
 
- Static Public Member Functions inherited from FIX::DateTime
static int makeHMS (int hour, int minute, int second, int millis)
 Helper method to convert a broken down time to a number of milliseconds since midnight. More...
 
static DateTime nowUtc ()
 Return the current wall-clock time as a utc DateTime. More...
 
static DateTime nowLocal ()
 Return the current wall-clock time as a local DateTime. More...
 
static DateTime fromUtcTimeT (time_t t, int millis=0)
 Convert a time_t and optional milliseconds to a DateTime. More...
 
static DateTime fromLocalTimeT (time_t t, int millis=0)
 
static DateTime fromTm (const tm &tm, int millis=0)
 Convert a tm and optional milliseconds to a DateTime. More...
 
static int julianDate (int year, int month, int day)
 Helper method to calculate a Julian day number. More...
 
static void getYMD (int jday, int &year, int &month, int &day)
 Convert a Julian day number to a year, month and day. More...
 
- Public Attributes inherited from FIX::DateTime
int m_date
 
int m_time
 

Detailed Description

Date only represented in UTC.

Definition at line 551 of file FieldTypes.h.

Constructor & Destructor Documentation

◆ UtcDate() [1/5]

FIX::UtcDate::UtcDate ( )
inline

Defaults to the current date.

Definition at line 555 of file FieldTypes.h.

556  {
557  setCurrent();
558  }
void setCurrent()
Set to the current time.
Definition: FieldTypes.h:579

◆ UtcDate() [2/5]

FIX::UtcDate::UtcDate ( const DateTime val)
inline

Definition at line 560 of file FieldTypes.h.

References FIX::DateTime::clearTime().

561  : DateTime( val )
562  {
563  clearTime();
564  }
void clearTime()
Clear the time portion of the DateTime.
Definition: FieldTypes.h:255
DateTime()
Default constructor - initializes to zero.
Definition: FieldTypes.h:73

◆ UtcDate() [3/5]

FIX::UtcDate::UtcDate ( int  date,
int  month,
int  year 
)
inline

Definition at line 566 of file FieldTypes.h.

567  : DateTime(year, month, date, 0, 0, 0, 0) {}
DateTime()
Default constructor - initializes to zero.
Definition: FieldTypes.h:73

◆ UtcDate() [4/5]

FIX::UtcDate::UtcDate ( int  sec)
inline

Definition at line 569 of file FieldTypes.h.

570  : DateTime( sec / DateTime::SECONDS_PER_DAY, 0 ) {}
DateTime()
Default constructor - initializes to zero.
Definition: FieldTypes.h:73

◆ UtcDate() [5/5]

FIX::UtcDate::UtcDate ( const tm *  time)
inline

Definition at line 572 of file FieldTypes.h.

References FIX::DateTime::clearTime().

573  : DateTime( fromTm (*time) )
574  {
575  clearTime();
576  }
void clearTime()
Clear the time portion of the DateTime.
Definition: FieldTypes.h:255
DateTime()
Default constructor - initializes to zero.
Definition: FieldTypes.h:73
static DateTime fromTm(const tm &tm, int millis=0)
Convert a tm and optional milliseconds to a DateTime.
Definition: FieldTypes.h:321

Member Function Documentation

◆ setCurrent()

void FIX::UtcDate::setCurrent ( )
inline

Set to the current time.

Definition at line 579 of file FieldTypes.h.

References FIX::DateTime::m_date, and FIX::DateTime::nowUtc().

580  {
581  DateTime d = nowUtc();
582  m_date = d.m_date;
583  }
DateTime()
Default constructor - initializes to zero.
Definition: FieldTypes.h:73
static DateTime nowUtc()
Return the current wall-clock time as a utc DateTime.
Definition: FieldTypes.cpp:34

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

Generated on Thu Sep 5 2019 11:07:58 for QuickFIX by doxygen 1.8.13 written by Dimitri van Heesch, © 1997-2001