highprecisionpso::ProgramVersion Class Reference

This class stores a program version. More...

#include <general_objects.h>

Public Member Functions

 ProgramVersion (int version, int version_minor, int version_patch_level)
 A constructor. More...
 
 ProgramVersion (std::string version_string)
 A constructor. More...
 
std::string GetCompleteVersion () const
 Returns a string, which represents the stored program version in the format "<version>.<version_minor>.<version_patch_level>". More...
 

Public Attributes

int version
 The major program version. More...
 
int version_minor
 The minor program version. More...
 
int version_patch_level
 The patch level. More...
 

Detailed Description

This class stores a program version.

Constructor & Destructor Documentation

highprecisionpso::ProgramVersion::ProgramVersion ( int  version,
int  version_minor,
int  version_patch_level 
)

A constructor.

Parameters
versionThe major program version.
version_minorThe minor program version.
version_patch_levelThe patch level.
highprecisionpso::ProgramVersion::ProgramVersion ( std::string  version_string)

A constructor.

Parameters
version_stringThis version string should have the format "<version>.<version_minor>.<version_patch_level>". Then the correct ProgramVersion is generated.

Member Function Documentation

std::string highprecisionpso::ProgramVersion::GetCompleteVersion ( ) const

Returns a string, which represents the stored program version in the format "<version>.<version_minor>.<version_patch_level>".

Returns
The program version as a string.

Member Data Documentation

int highprecisionpso::ProgramVersion::version

The major program version.

int highprecisionpso::ProgramVersion::version_minor

The minor program version.

int highprecisionpso::ProgramVersion::version_patch_level

The patch level.


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