CTR Pia  4.11.3
Game Communication Engine
nn::pia::common::DateTime Class Reference

Class that represents time. More...

+ Inheritance diagram for nn::pia::common::DateTime:

Public Member Functions

 DateTime ()
 Instantiates an object with default parameters (default constructor).
 
 DateTime (const DateTime &rhs)
 The copy constructor. More...
 
 DateTime (u16 year, u8 month, u8 day, u8 hour, u8 minute, u8 second)
 Instantiates an object with the specified date and time. More...
 
virtual ~DateTime ()
 The destructor.
 
void Clear ()
 Clears the specified date and time.
 
u8 GetDay () const
 Gets the specified day. More...
 
u8 GetHour () const
 Gets the specified hour. More...
 
u8 GetMinute () const
 Gets the specified minutes. More...
 
u8 GetMonth () const
 Gets the specified month. More...
 
u8 GetSecond () const
 Gets the specified seconds. More...
 
u16 GetYear () const
 Gets the specified year. More...
 
bool IsRegistered () const
 Gets whether a value has been specified. More...
 
bool IsValid () const
 Gets whether the specified date and time is correct. More...
 
DateTimeoperator= (const DateTime &rhs)
 Assignment operator. More...
 
void SetDay (u8 day)
 Specifies the day. More...
 
void SetHour (u8 hour)
 Specifies the hour. More...
 
void SetMinute (u8 minute)
 Specifies the minutes. More...
 
void SetMonth (u8 month)
 Specifies the month. More...
 
void SetSecond (u8 second)
 Specifies the seconds. More...
 
void SetYear (u16 year)
 Specifies the year. More...
 

Detailed Description

Class that represents time.

Constructor & Destructor Documentation

nn::pia::common::DateTime::DateTime ( const DateTime rhs)
inline

The copy constructor.

Parameters
[in]rhsSpecifies the DateTime to copy.
nn::pia::common::DateTime::DateTime ( u16  year,
u8  month,
u8  day,
u8  hour,
u8  minute,
u8  second 
)
inline

Instantiates an object with the specified date and time.

Parameters
[in]yearYear.
[in]monthMonth.
[in]dayDay.
[in]hourHour.
[in]minuteMinutes.
[in]secondSeconds.

Member Function Documentation

u8 nn::pia::common::DateTime::GetDay ( ) const
inline

Gets the specified day.

Returns
Returns the specified day.
u8 nn::pia::common::DateTime::GetHour ( ) const
inline

Gets the specified hour.

Returns
Returns the specified hour.
u8 nn::pia::common::DateTime::GetMinute ( ) const
inline

Gets the specified minutes.

Returns
Returns the specified minutes.
u8 nn::pia::common::DateTime::GetMonth ( ) const
inline

Gets the specified month.

Returns
Returns the specified month.
u8 nn::pia::common::DateTime::GetSecond ( ) const
inline

Gets the specified seconds.

Returns
Returns the specified seconds.
u16 nn::pia::common::DateTime::GetYear ( ) const
inline

Gets the specified year.

Returns
Returns the specified year.
bool nn::pia::common::DateTime::IsRegistered ( ) const
inline

Gets whether a value has been specified.

Returns
Returns true if a value is specified.
bool nn::pia::common::DateTime::IsValid ( ) const
inline

Gets whether the specified date and time is correct.

Returns
Returns true if the specified date and time is correct.
DateTime& nn::pia::common::DateTime::operator= ( const DateTime rhs)
inline

Assignment operator.

Parameters
[in]rhsAssignment date and time.
void nn::pia::common::DateTime::SetDay ( u8  day)
inline

Specifies the day.

Specify a value in the range from 1 to 31.

Parameters
[in]dayDay.
void nn::pia::common::DateTime::SetHour ( u8  hour)
inline

Specifies the hour.

Specify a value in the range from 0 to 23.

Parameters
[in]hourHour.
void nn::pia::common::DateTime::SetMinute ( u8  minute)
inline

Specifies the minutes.

Specify a value in the range from 0 to 59.

Parameters
[in]minuteMinutes.
void nn::pia::common::DateTime::SetMonth ( u8  month)
inline

Specifies the month.

Specify a value in the range from 1 to 12.

Parameters
[in]monthMonth.
void nn::pia::common::DateTime::SetSecond ( u8  second)
inline

Specifies the seconds.

Specify a value in the range from 0 to 59.

Parameters
[in]secondSeconds.
void nn::pia::common::DateTime::SetYear ( u16  year)
inline

Specifies the year.

Specify a value in the range from 1 to 9999.

Parameters
[in]yearYear.