OnixS ICE iMpact Multicast Price Feed Handler C++ library  8.18.0
API documentation
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
YearMonth Class Reference

#include <Time.h>

Classes

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
 
YearMonth & operator= (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 239 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.

Exceptions
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 &   
)
protected

Initializes instance without verifying input.

Member Function Documentation

static YearMonth deserialize ( unsigned long  long)
static

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

Month month ( ) const
inline

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

Definition at line 301 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
inline

Serializes into text (YYYYMM) presentation.

Definition at line 306 of file Time.h.

void toString ( std::string &  ) const

Serializes into text (YYYYMM) presentation.

unsigned int year ( ) const
inline

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

Definition at line 296 of file Time.h.

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