xvr2::Time Class Reference
#include <Time.h>
Inheritance diagram for xvr2::Time:
Detailed Description
This class represents the time object.Definition at line 24 of file Time.h.
Public Types | |
| enum | DateAMPM { AM, PM } |
| enum | DateARITHParts { DAYS, HOURS, MINUTES, SECONDS } |
Public Member Functions | |
| Time () | |
| Default constructor, it does nothing. | |
| Time (UInt32 tstamp) | |
| This will initialize all internal variables to the timestamp tstamp. | |
| Time (int hour, int min, int sec) | |
| This will initialize the internal values to the corresponding hour, min and sec. | |
| Time (const char *time_text) | |
| This constructor will attempt to convert the time given as a string in the format HH:MM:SS. | |
| Time (const String &time_text) | |
| This constructor will attempt to convert the time given as a string in the format HH:MM:SS. | |
| Time (const Time *t) | |
| Time (const Time &t) | |
| virtual | ~Time () |
| Time & | operator= (const Time &t) |
| virtual int | Hour () |
| Returns the current hour. | |
| virtual int | Minute () |
| Returns the current minute. | |
| virtual int | Second () |
| Returns the current second. | |
| const UInt32 | timestamp () |
| Returns time in the following format: HH:MM:SS. | |
| virtual time_t | getCurrentTime () |
| This method will update the value of unixtime and all the other broken-time values. | |
| const UInt32 | unixTime () |
| This methid will give you the numeric representation of the date in the unix time format. | |
| const UInt32 | unixTime () const |
| virtual std::string | toString () |
| This will convert the current date object to the following format: YYYY-MM-DD HH:MM:SS. | |
| virtual void | add (DateARITHParts component, int value) |
| virtual const char * | getClassName () |
| Returns the name of the current class. | |
Static Public Member Functions | |
| static Date | Now () |
| static void | usleep (UInt32 usec) |
| This will return how many CPUs are installed in the system. | |
| static void | debugmsg (Object *obj, const char *msg, int linenumber=__LINE__, const char *srcfile=__FILE__) |
| Will print a debug message to the screen. | |
| static void | debugmsgln (Object *obj, const char *msg, int linenumber=__LINE__, const char *srcfile=__FILE__) |
Public Attributes | |
| int | hour |
| This member stores the hour 0-23. | |
| int | hr12hour |
| This member will show the hour using non-24hr format. | |
| int | minute |
| This member stores the minute 0-59. | |
| int | second |
| This member stores the second 0-59. | |
| int | dayofweek |
| This member stores the day of the week e.g Monday, Tuesday, Wednesday. | |
| int | dayofyear |
| This member stores the days elapsed since january first of the current year. | |
| int | dayofmonth |
| This member stores the day of the month 1-31. | |
| int | month |
| This member stores the month 1-12. | |
| int | year |
| This member stores the year 1960 - ???? | |
| int | hr12ampm |
| This member knows whether the timing is AM or PM. | |
Protected Member Functions | |
| virtual void | encode () |
| void | setTStamp (UInt32 tstamp) |
| This member holds the String representation of the current Date. | |
| void | decode (const char *format, const char *date_text) |
Protected Attributes | |
| time_t | unixtime |
| This variable stores the time queried by getCurrentTime();. | |
| std::string * | string_representation |
| std::string | __cls_name |
Friends | |
| std::ostream & | operator<< (std::ostream &stream, const Object &s) |
Member Enumeration Documentation
enum xvr2::Date::DateAMPM [inherited] |
enum xvr2::Date::DateARITHParts [inherited] |
Constructor & Destructor Documentation
| xvr2::Time::Time | ( | ) |
Default constructor, it does nothing.
| xvr2::Time::Time | ( | UInt32 | tstamp | ) |
This will initialize all internal variables to the timestamp tstamp.
| xvr2::Time::Time | ( | int | hour, | |
| int | min, | |||
| int | sec | |||
| ) |
This will initialize the internal values to the corresponding hour, min and sec.
| xvr2::Time::Time | ( | const char * | time_text | ) |
This constructor will attempt to convert the time given as a string in the format HH:MM:SS.
- Parameters:
-
time_text Time in string format
| xvr2::Time::Time | ( | const String & | time_text | ) |
This constructor will attempt to convert the time given as a string in the format HH:MM:SS.
- Parameters:
-
time_text Time in string format
| xvr2::Time::Time | ( | const Time * | t | ) |
| xvr2::Time::Time | ( | const Time & | t | ) |
| virtual xvr2::Time::~Time | ( | ) | [virtual] |
Member Function Documentation
| virtual void xvr2::Time::encode | ( | ) | [protected, virtual] |
Reimplemented from xvr2::Date.
| virtual int xvr2::Time::Hour | ( | ) | [virtual] |
Returns the current hour.
| virtual int xvr2::Time::Minute | ( | ) | [virtual] |
Returns the current minute.
| virtual int xvr2::Time::Second | ( | ) | [virtual] |
Returns the current second.
| const UInt32 xvr2::Time::timestamp | ( | ) |
Returns time in the following format: HH:MM:SS.
This will return the time as a Unix formatted timestamp counting the seconds from january 1st 1970
| void xvr2::Date::setTStamp | ( | UInt32 | tstamp | ) | [protected, inherited] |
| void xvr2::Date::decode | ( | const char * | format, | |
| const char * | date_text | |||
| ) | [protected, inherited] |
| virtual time_t xvr2::Date::getCurrentTime | ( | ) | [virtual, inherited] |
This method will update the value of unixtime and all the other broken-time values.
| const UInt32 xvr2::Date::unixTime | ( | ) | [inherited] |
This methid will give you the numeric representation of the date in the unix time format.
| const UInt32 xvr2::Date::unixTime | ( | ) | const [inherited] |
| virtual std::string xvr2::Date::toString | ( | ) | [virtual, inherited] |
This will convert the current date object to the following format: YYYY-MM-DD HH:MM:SS.
Reimplemented from xvr2::Object.
| virtual void xvr2::Date::add | ( | DateARITHParts | component, | |
| int | value | |||
| ) | [virtual, inherited] |
| static Date xvr2::Date::Now | ( | ) | [static, inherited] |
| static void xvr2::System::usleep | ( | UInt32 | usec | ) | [static, inherited] |
This will return how many CPUs are installed in the system.
This will return the CPU speed in megahertz Will return the total amount of system memory Will return the total amount of free system memory Will freeze the software for usec microseconds
| virtual const char* xvr2::Object::getClassName | ( | ) | [virtual, inherited] |
Returns the name of the current class.
| static void xvr2::Object::debugmsg | ( | Object * | obj, | |
| const char * | msg, | |||
| int | linenumber = __LINE__, |
|||
| const char * | srcfile = __FILE__ | |||
| ) | [static, inherited] |
Will print a debug message to the screen.
| static void xvr2::Object::debugmsgln | ( | Object * | obj, | |
| const char * | msg, | |||
| int | linenumber = __LINE__, |
|||
| const char * | srcfile = __FILE__ | |||
| ) | [static, inherited] |
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | stream, | |
| const Object & | s | |||
| ) | [friend, inherited] |
Member Data Documentation
time_t xvr2::Date::unixtime [protected, inherited] |
std::string* xvr2::Date::string_representation [protected, inherited] |
int xvr2::Date::hour [inherited] |
int xvr2::Date::hr12hour [inherited] |
int xvr2::Date::minute [inherited] |
int xvr2::Date::second [inherited] |
int xvr2::Date::dayofweek [inherited] |
int xvr2::Date::dayofyear [inherited] |
int xvr2::Date::dayofmonth [inherited] |
int xvr2::Date::month [inherited] |
int xvr2::Date::year [inherited] |
int xvr2::Date::hr12ampm [inherited] |
std::string xvr2::Object::__cls_name [protected, inherited] |
The documentation for this class was generated from the following file:
- /home/coredumped/X-VR2_Trunk/Core/xvr2/Time.h
