InDetDD::Version Class Reference

Class to hold version information consisting of tag, name layout and description as strings, such as their integer regpresentation in the major-minor-tag scheme. More...

#include <Version.h>

Collaboration diagram for InDetDD::Version:

Public Member Functions
	Version (const std::string &tag, const std::string &name, const std::string &layout, const std::string &description, int major, int minor, int patch)
	Constructor.
	Version ()
	Empty Constructor.
const std::string &	tag () const
	Version tag.
const std::string &	name () const
	Version label.
const std::string &	layout () const
	Layout (eg Initial, Final, TestBeam)
const std::string &	description () const
	Description or comment.
int	majorNum () const
	Major version number.
int	minorNum () const
	Minor version number.
int	patchNum () const
	Patch version number.
std::string	versionNumber () const
	Print out version number (eg.
std::string	fullDescription () const
	Full Description For example, Version: SCT-DC1-00, Name: DC1, Layout: Final, Code Version: 2.00.00, Description: DC1 Geometry.

Private Attributes
std::string	m_tag
std::string	m_name
std::string	m_layout
std::string	m_description
int	m_major
int	m_minor
int	m_patch

Detailed Description

Class to hold version information consisting of tag, name layout and description as strings, such as their integer regpresentation in the major-minor-tag scheme.

Definition at line 24 of file Version.h.

Constructor & Destructor Documentation

Version() [1/2]

InDetDD::Version::Version	(	const std::string &	tag,
		const std::string &	name,
		const std::string &	layout,
		const std::string &	description,
		int	major,
		int	minor,
		int	patch )

Constructor.

Definition at line 13 of file Version.cxx.

  : m_tag(tag),
    m_name(name),
    m_layout(layout),
    m_description(description),
    m_major(major),
    m_minor(minor),
    m_patch(patch)
{}

Version() [2/2]

InDetDD::Version::Version

(

)

Empty Constructor.

Definition at line 31 of file Version.cxx.

  : m_major(0),
    m_minor(0),
    m_patch(0)
{}

Member Function Documentation

description()

const std::string & InDetDD::Version::description

(

)

const

Description or comment.

Definition at line 56 of file Version.cxx.

{
  return m_description;
}

fullDescription()

std::string InDetDD::Version::fullDescription

(

)

const

Full Description For example, Version: SCT-DC1-00, Name: DC1, Layout: Final, Code Version: 2.00.00, Description: DC1 Geometry.

Definition at line 90 of file Version.cxx.

{
 
  //  Output of the form
  //  Version: SCT-DC1-00, Name: DC1, Layout: Final, Code Version: 02.01.01, Description: DC1 Geometry
 
  std::ostringstream ostr;
  ostr << "Version: " << m_tag << ", Name: " << m_name << ", Layout: " << m_layout 
       << ", Code Version: " << versionNumber();
  if (!m_description.empty()) { 
    ostr << ", Description: " << m_description;
  }
  return ostr.str();
}

layout()

const std::string & InDetDD::Version::layout

(

)

const

Layout (eg Initial, Final, TestBeam)

Definition at line 50 of file Version.cxx.

{
  return m_layout;
}

majorNum()

int InDetDD::Version::majorNum

(

)

const

Major version number.

Definition at line 62 of file Version.cxx.

{
  return m_major;
}

minorNum()

int InDetDD::Version::minorNum

(

)

const

Minor version number.

Definition at line 68 of file Version.cxx.

{
  return m_minor;
}

name()

const std::string & InDetDD::Version::name

(

)

const

Version label.

Definition at line 44 of file Version.cxx.

{
  return m_name;
}

patchNum()

int InDetDD::Version::patchNum

(

)

const

Patch version number.

Definition at line 74 of file Version.cxx.

{
  return m_patch;
}

tag()

const std::string & InDetDD::Version::tag

(

)

const

Version tag.

Definition at line 38 of file Version.cxx.

{
  return m_tag;
}

versionNumber()

std::string InDetDD::Version::versionNumber

(

)

const

Print out version number (eg.

2.00.00)

Definition at line 80 of file Version.cxx.

{
  std::ostringstream ostr;
  ostr << m_major 
       << "." << std::setfill('0') << std::setw(2) << m_minor 
       << "." << std::setfill('0') << std::setw(2) << m_patch;
  return ostr.str();
}

Member Data Documentation

m_description

std::string InDetDD::Version::m_description

private

Definition at line 75 of file Version.h.

m_layout

std::string InDetDD::Version::m_layout

private

Definition at line 74 of file Version.h.

m_major

int InDetDD::Version::m_major

private

Definition at line 76 of file Version.h.

m_minor

int InDetDD::Version::m_minor

private

Definition at line 77 of file Version.h.

m_name

std::string InDetDD::Version::m_name

private

Definition at line 73 of file Version.h.

m_patch

int InDetDD::Version::m_patch

private

Definition at line 78 of file Version.h.

m_tag

std::string InDetDD::Version::m_tag

private

Definition at line 72 of file Version.h.

---

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

• Version.h
• Version.cxx