OnixS C++ B3 Binary UMDF Market Data Handler  1.3.4
API documentation
Classes | Public Types | Public Member Functions | List of all members
MaturityMonthYear Class Reference

#include <OnixS/B3/MarketData/UMDF/messaging/Composites.h>

Public Types

enum  { Size = 5 }
 
typedef UInt16 Year
 
typedef IntegralConstant< UInt16, 0 > NullYear
 
typedef UInt8 Month
 
typedef IntegralConstant< UInt8, 0 > NullMonth
 
typedef UInt8 Day
 
typedef IntegralConstant< UInt8, 0 > NullDay
 
typedef UInt8 Week
 
typedef IntegralConstant< UInt8, 0 > NullWeek
 

Public Member Functions

 MaturityMonthYear () throw ()
 
 MaturityMonthYear (Year year, Month month, Day day, Week week) throw ()
 
ONIXS_B3_UMDF_MD_NODISCARD std::string toString () const
 
ONIXS_B3_UMDF_MD_NODISCARD Year year () const throw ()
 
ONIXS_B3_UMDF_MD_NODISCARD bool month (Month &value) const throw ()
 
ONIXS_B3_UMDF_MD_NODISCARD bool day (Day &value) const throw ()
 
ONIXS_B3_UMDF_MD_NODISCARD bool week (Week &value) const throw ()
 
ONIXS_B3_UMDF_MD_NODISCARD bool operator== (const MaturityMonthYear &other) const throw ()
 
ONIXS_B3_UMDF_MD_NODISCARD bool operator!= (const MaturityMonthYear &other) const throw ()
 

Detailed Description

FIX type: MonthYear.

Definition at line 978 of file Composites.h.

Member Typedef Documentation

typedef UInt8 Day

Day of month (1 to 31).

Definition at line 1001 of file Composites.h.

typedef UInt8 Month

Month (1 to 12).

Definition at line 993 of file Composites.h.

typedef IntegralConstant<UInt8, 0> NullDay

Null value for an optional Day field.

Definition at line 1006 of file Composites.h.

typedef IntegralConstant<UInt8, 0> NullMonth

Null value for an optional Month field.

Definition at line 998 of file Composites.h.

typedef IntegralConstant<UInt8, 0> NullWeek

Null value for an optional Week field.

Definition at line 1014 of file Composites.h.

typedef IntegralConstant<UInt16, 0> NullYear

Null value for an optional Year field.

Definition at line 990 of file Composites.h.

typedef UInt8 Week

Week of month (1 to 5).

Definition at line 1009 of file Composites.h.

typedef UInt16 Year

4-digit year.

Definition at line 985 of file Composites.h.

Member Enumeration Documentation

anonymous enum

Size of the composite.

Enumerator
Size 

Definition at line 982 of file Composites.h.

Constructor & Destructor Documentation

MaturityMonthYear ( )
throw (
)
inline

Default constructor.

Initializes fields with appropriate null values.

Definition at line 1020 of file Composites.h.

MaturityMonthYear ( Year  year,
Month  month,
Day  day,
Week  week 
)
throw (
)
inline

Initializes fields with provided values.

Definition at line 1031 of file Composites.h.

Member Function Documentation

ONIXS_B3_UMDF_MD_NODISCARD bool day ( Day &  value) const
throw (
)
inline

Day of month (1 to 31).

Definition at line 1083 of file Composites.h.

ONIXS_B3_UMDF_MD_NODISCARD bool month ( Month &  value) const
throw (
)
inline

Month (1 to 12).

Definition at line 1074 of file Composites.h.

ONIXS_B3_UMDF_MD_NODISCARD bool operator!= ( const MaturityMonthYear &  other) const
throw (
)
inline

Compares encoded data.

Definition at line 1109 of file Composites.h.

bool operator== ( const MaturityMonthYear &  other) const
throw (
)
inline

Compares encoded data.

Definition at line 1176 of file Composites.h.

std::string toString ( ) const
inline
Returns
a human-readable presentation.

Definition at line 2126 of file Serialization.h.

ONIXS_B3_UMDF_MD_NODISCARD bool week ( Week &  value) const
throw (
)
inline

Week of month (1 to 5).

Definition at line 1092 of file Composites.h.

ONIXS_B3_UMDF_MD_NODISCARD Year year ( ) const
throw (
)
inline

4-digit year.

Definition at line 1066 of file Composites.h.

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