OnixS BME SENAF Handler C++ library  2.1.2
API documentation
YearMonth Class Reference

#include <OnixS/Senaf/MarketData/Time.h>


struct  NoVerify

Public Member Functions

 YearMonth ()
 YearMonth (unsigned int year, Month month)
 YearMonth (const YearMonth &other)
unsigned int year () const
Month month () const
bool operator== (const YearMonth &) const
bool operator!= (const YearMonth &) const
YearMonthoperator= (const YearMonth &other)
std::string toString () const
void toString (std::string &) const

Static Public Member Functions

static YearMonth deserialize (unsigned long long)

Protected Member Functions

 YearMonth (unsigned int, Month, const NoVerify &)

Detailed Description

Represents month-year pair. Year must fit into [0001, 9999] range. Month must fit into [01, 12] range.

Definition at line 235 of file Time.h.

Constructor & Destructor Documentation

YearMonth ( )

Initializes instance as Jan, 0001.

YearMonth ( unsigned int  year,
Month  month 

Initializes instance with given values. Input parameters are checked for validness.

exceptionif input parameters do not fit into a valid range.
YearMonth ( const YearMonth other)

Initializes as copy of other instance.

YearMonth ( unsigned  int,
Month  ,
const NoVerify  

Initializes instance without verifying input.

Member Function Documentation

static YearMonth deserialize ( unsigned long  long)

De-serializes instance from its numeric presentation as it's used by Senaf.

Month month ( ) const

Month component. Valid range of values is [01, 12].

Definition at line 295 of file Time.h.

bool operator!= ( const YearMonth ) const

Compares with other instance for inequality.

YearMonth& operator= ( const YearMonth other)
bool operator== ( const YearMonth ) const

Compares with other instance for equality.

std::string toString ( ) const

Serializes into text (YYYYMM) presentation.

Definition at line 300 of file Time.h.

void toString ( std::string &  ) const

Serializes into text (YYYYMM) presentation.

unsigned int year ( ) const

Year component. Valid range of values is [0001, 9999].

Definition at line 290 of file Time.h.

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