OnixS C++ B3 BOE Binary Order Entry 1.4.0
Users' manual and API documentation
Loading...
Searching...
No Matches
Version Class Reference

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

Public Types

enum  
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 (bool skipEmptyFields=false) 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 2118 of file Composites.h.

Member Typedef Documentation

◆ BuildNumber

typedef UInt8 BuildNumber

Build number.

Definition at line 2149 of file Composites.h.

◆ MajorNumber

typedef UInt8 MajorNumber

Major release number.

Definition at line 2125 of file Composites.h.

◆ MinorNumber

typedef UInt8 MinorNumber

Minor release number.

Definition at line 2133 of file Composites.h.

◆ NullBuildNumber

typedef IntegralConstant<UInt8, 255> NullBuildNumber

Null value for an optional BuildNumber field.

Definition at line 2154 of file Composites.h.

◆ NullMajorNumber

typedef IntegralConstant<UInt8, 255> NullMajorNumber

Null value for an optional MajorNumber field.

Definition at line 2130 of file Composites.h.

◆ NullMinorNumber

typedef IntegralConstant<UInt8, 255> NullMinorNumber

Null value for an optional MinorNumber field.

Definition at line 2138 of file Composites.h.

◆ NullPatchNumber

typedef IntegralConstant<UInt8, 255> NullPatchNumber

Null value for an optional PatchNumber field.

Definition at line 2146 of file Composites.h.

◆ PatchNumber

typedef UInt8 PatchNumber

Maintenance release number.

Definition at line 2141 of file Composites.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Size of the composite.

Enumerator
Size 4 

Definition at line 2122 of file Composites.h.

Member Function Documentation

◆ buildNumber()

bool buildNumber ( BuildNumber & value) const
inlinenoexcept

Build number.

Definition at line 2229 of file Composites.h.

◆ majorNumber()

MajorNumber majorNumber ( ) const
inlinenoexcept

Major release number.

Definition at line 2164 of file Composites.h.

◆ minorNumber()

bool minorNumber ( MinorNumber & value) const
inlinenoexcept

Minor release number.

Definition at line 2185 of file Composites.h.

◆ patchNumber()

bool patchNumber ( PatchNumber & value) const
inlinenoexcept

Maintenance release number.

Definition at line 2207 of file Composites.h.

◆ setBuildNumber()

void setBuildNumber ( BuildNumber value)
inlinenoexcept

Build number.

Definition at line 2237 of file Composites.h.

◆ setBuildNumberToNull()

void setBuildNumberToNull ( )
inlinenoexcept

Definition at line 2243 of file Composites.h.

◆ setMajorNumber()

void setMajorNumber ( MajorNumber value)
inlinenoexcept

Major release number.

Definition at line 2171 of file Composites.h.

◆ setMajorNumberToNull()

void setMajorNumberToNull ( )
inlinenoexcept

Definition at line 2177 of file Composites.h.

◆ setMinorNumber()

void setMinorNumber ( MinorNumber value)
inlinenoexcept

Minor release number.

Definition at line 2193 of file Composites.h.

◆ setMinorNumberToNull()

void setMinorNumberToNull ( )
inlinenoexcept

Definition at line 2199 of file Composites.h.

◆ setPatchNumber()

void setPatchNumber ( PatchNumber value)
inlinenoexcept

Maintenance release number.

Definition at line 2215 of file Composites.h.

◆ setPatchNumberToNull()

void setPatchNumberToNull ( )
inlinenoexcept

Definition at line 2221 of file Composites.h.

◆ toString()

std::string toString ( bool skipEmptyFields = false) const
inline
Returns
a human-readable presentation.

Definition at line 3645 of file Serialization.h.