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

A class that represents a particular month in the modern calendar. More...

#include <omMonth.h>

Public Member Functions

 Month ()
 Create a Month object representing the first month of the year. More...
 
 Month (Index newNumber)
 Create a Month object with the specified index within the year, starting at 1. More...
 
data::String getName () const
 Get the standard name for the month with this index. More...
 
Index getNumber () const
 Get the index of the month within the year, starting at 1. More...
 
void setNumber (Index newNumber)
 Set the index of the month within the year, starting at 1. More...
 

Detailed Description

A class that represents a particular month in the modern calendar.

Constructor & Destructor Documentation

om::time::Month::Month ( )
inline

Create a Month object representing the first month of the year.

om::time::Month::Month ( Index  newNumber)
inline

Create a Month object with the specified index within the year, starting at 1.

Member Function Documentation

data::String om::time::Month::getName ( ) const
inline

Get the standard name for the month with this index.

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

Index om::time::Month::getNumber ( ) const
inline

Get the index of the month within the year, starting at 1.

void om::time::Month::setNumber ( Index  newNumber)
inline

Set the index of the month within the year, starting at 1.


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