eformat::helper::Version Class Reference

#include <Version.h>

Public Member Functions
	Version (uint16_t minor, uint16_t major=MAJOR_DEFAULT_VERSION)
	Version (uint32_t v=DEFAULT_VERSION)
uint16_t	major2 (void) const
uint16_t	minor2 (void) const
uint32_t	code (void) const
std::string	human_major (void) const
std::string	human_minor (void) const
std::string	human (void) const

Detailed Description

Defines converters between version numbers and its components

Definition at line 41 of file Version.h.

Constructor & Destructor Documentation

Version() [1/2]

eformat::helper::Version::Version ( uint16_t  minor, uint16_t  major = MAJOR_DEFAULT_VERSION  )

inline

Constructor. Takes the components to form a version

Parameters

minor	The minor version
major	The major version

Definition at line 50 of file Version.h.

    : m_minor(minor), m_major(major) {}

Version() [2/2]

eformat::helper::Version::Version

(

uint32_t

v = DEFAULT_VERSION

)

Constructor. Takes the version to understand the components from.

Parameters

v	The version number, fully built.

Warning

This version number has to conform to the current version of the library or unpredictable results might occur.

Definition at line 16 of file Version.cxx.

  : m_minor(0xffff&v), m_major(v>>16)
{
}

Member Function Documentation

code()

uint32_t eformat::helper::Version::code

(

void

)

const

Gets the full 32-bit number made by assembling the 2 numbers above.

Definition at line 21 of file Version.cxx.

{
  uint32_t retval = m_major;
  retval <<= 16;
  retval |= m_minor;
  return retval;
}

human()

std::string eformat::helper::Version::human

(

void

)

const

Returns a string representation of the version number

Definition at line 43 of file Version.cxx.

{
  std::string retval = human_major();
  retval += "-";
  retval += human_minor();
  return retval;
}

human_major()

std::string eformat::helper::Version::human_major

(

void

)

const

Returns a string representation of the major version number

Definition at line 29 of file Version.cxx.

{
  std::ostringstream oss;
  oss << (major2() >> 8) << "." << (major2() & 0xff);
  return oss.str();
}

human_minor()

std::string eformat::helper::Version::human_minor

(

void

)

const

Returns a string representation of the minor version number

Definition at line 36 of file Version.cxx.

{
  std::ostringstream oss;
  oss << (minor2() >> 8) << "." << (minor2() & 0xff);
  return oss.str();
}

major2()

uint16_t eformat::helper::Version::major2 ( void  ) const

inline

Extracts the major version part of this version

Definition at line 65 of file Version.h.

{ return m_major; }

Referenced by eformat::old::convert(), and convert_ros().

minor2()

uint16_t eformat::helper::Version::minor2 ( void  ) const

inline

Extracts the minor version part of this version

Definition at line 70 of file Version.h.

{ return m_minor; }

Referenced by eformat::old::convert(), and convert_ros().

---

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

• Version.h
• Version.cxx