OnixS C++ B3 BOE Binary Order Entry  1.3.0
API Documentation
Public Types | Public Member Functions | List of all members
Version Class Reference

#include <OnixS/B3/BOE/messaging/Composites.h>

Public Types

enum  { Size = 4 }
 
typedef UInt8 MajorNumber
 
typedef IntegralConstant< UInt8, 255 > NullMajorNumber
 
typedef UInt8 MinorNumber
 
typedef IntegralConstant< UInt8, 255 > NullMinorNumber
 
typedef UInt8 PatchNumber
 
typedef IntegralConstant< UInt8, 255 > NullPatchNumber
 
typedef UInt8 BuildNumber
 
typedef IntegralConstant< UInt8, 255 > NullBuildNumber
 

Public Member Functions

std::string toString () const
 
MajorNumber majorNumber () const noexcept
 
void setMajorNumber (MajorNumber value) noexcept
 
void setMajorNumberToNull () noexcept
 
bool minorNumber (MinorNumber &value) const noexcept
 
void setMinorNumber (MinorNumber value) noexcept
 
void setMinorNumberToNull () noexcept
 
bool patchNumber (PatchNumber &value) const noexcept
 
void setPatchNumber (PatchNumber value) noexcept
 
void setPatchNumberToNull () noexcept
 
bool buildNumber (BuildNumber &value) const noexcept
 
void setBuildNumber (BuildNumber value) noexcept
 
void setBuildNumberToNull () noexcept
 

Detailed Description

Definition at line 2086 of file Composites.h.

Member Typedef Documentation

typedef UInt8 BuildNumber

Build number.

Definition at line 2117 of file Composites.h.

typedef UInt8 MajorNumber

Major release number.

Definition at line 2093 of file Composites.h.

typedef UInt8 MinorNumber

Minor release number.

Definition at line 2101 of file Composites.h.

typedef IntegralConstant<UInt8, 255> NullBuildNumber

Null value for an optional BuildNumber field.

Definition at line 2122 of file Composites.h.

typedef IntegralConstant<UInt8, 255> NullMajorNumber

Null value for an optional MajorNumber field.

Definition at line 2098 of file Composites.h.

typedef IntegralConstant<UInt8, 255> NullMinorNumber

Null value for an optional MinorNumber field.

Definition at line 2106 of file Composites.h.

typedef IntegralConstant<UInt8, 255> NullPatchNumber

Null value for an optional PatchNumber field.

Definition at line 2114 of file Composites.h.

typedef UInt8 PatchNumber

Maintenance release number.

Definition at line 2109 of file Composites.h.

Member Enumeration Documentation

anonymous enum

Size of the composite.

Enumerator
Size 

Definition at line 2090 of file Composites.h.

Member Function Documentation

bool buildNumber ( BuildNumber &  value) const
inlinenoexcept

Build number.

Definition at line 2196 of file Composites.h.

MajorNumber majorNumber ( ) const
inlinenoexcept

Major release number.

Definition at line 2131 of file Composites.h.

bool minorNumber ( MinorNumber &  value) const
inlinenoexcept

Minor release number.

Definition at line 2152 of file Composites.h.

bool patchNumber ( PatchNumber &  value) const
inlinenoexcept

Maintenance release number.

Definition at line 2174 of file Composites.h.

void setBuildNumber ( BuildNumber  value)
inlinenoexcept

Build number.

Definition at line 2204 of file Composites.h.

void setBuildNumberToNull ( )
inlinenoexcept

Definition at line 2210 of file Composites.h.

void setMajorNumber ( MajorNumber  value)
inlinenoexcept

Major release number.

Definition at line 2138 of file Composites.h.

void setMajorNumberToNull ( )
inlinenoexcept

Definition at line 2144 of file Composites.h.

void setMinorNumber ( MinorNumber  value)
inlinenoexcept

Minor release number.

Definition at line 2160 of file Composites.h.

void setMinorNumberToNull ( )
inlinenoexcept

Definition at line 2166 of file Composites.h.

void setPatchNumber ( PatchNumber  value)
inlinenoexcept

Maintenance release number.

Definition at line 2182 of file Composites.h.

void setPatchNumberToNull ( )
inlinenoexcept

Definition at line 2188 of file Composites.h.

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

Definition at line 3260 of file Serialization.h.

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