Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::time::Day Class Reference

A class that represents a single day within a week, month, and year of the modern calendar. More...

#include <omDay.h>

Public Member Functions

 Day (Index newDayOfTheWeek, Index newDayOfTheMonth, Index newDayOfTheYear)
 Create a Day object with the specified day of the week, month, and year indicies, starting at 1. More...
 
Index getDayOfTheWeek () const
 Get the day of the week index of this Day, starting at 1. More...
 
void setDayOfTheWeek (Index newDayOfTheWeek)
 Set the day of the week index of this Day, starting at 1. More...
 
Index getDayOfTheMonth () const
 Get the day of the month index of this Day, starting at 1. More...
 
void setDayOfTheMonth (Index newDayOfTheMonth)
 Set the day of the month index of this Day, starting at 1. More...
 
Index getDayOfTheYear () const
 Get the day of the year index of this Day, starting at 1. More...
 
void setDayOfTheYear (Index newDayOfTheYear)
 Set the day of the year index of this Day, starting at 1. More...
 
data::String getName () const
 Get the standard name for the day with this day of the week index. More...
 

Detailed Description

A class that represents a single day within a week, month, and year of the modern calendar.

Constructor & Destructor Documentation

om::time::Day::Day ( Index  newDayOfTheWeek,
Index  newDayOfTheMonth,
Index  newDayOfTheYear 
)
inline

Create a Day object with the specified day of the week, month, and year indicies, starting at 1.

Member Function Documentation

Index om::time::Day::getDayOfTheWeek ( ) const
inline

Get the day of the week index of this Day, starting at 1.

void om::time::Day::setDayOfTheWeek ( Index  newDayOfTheWeek)
inline

Set the day of the week index of this Day, starting at 1.

Index om::time::Day::getDayOfTheMonth ( ) const
inline

Get the day of the month index of this Day, starting at 1.

void om::time::Day::setDayOfTheMonth ( Index  newDayOfTheMonth)
inline

Set the day of the month index of this Day, starting at 1.

Index om::time::Day::getDayOfTheYear ( ) const
inline

Get the day of the year index of this Day, starting at 1.

void om::time::Day::setDayOfTheYear ( Index  newDayOfTheYear)
inline

Set the day of the year index of this Day, starting at 1.

data::String om::time::Day::getName ( ) const

Get the standard name for the day with this day of the week index.

If the day does not have a standard name, the empty string is returned.


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