epics::pvAccess::Version Class Reference

#include "pvaVersion.h"

Public Member Functions
	Version (std::string const &productName, std::string const &implementationLangugage, int majorVersion, int minorVersion, int maintenanceVersion, bool developmentFlag)
const std::string	getProductName () const
const std::string	getImplementationLanguage () const
int	getMajorVersion () const
int	getMinorVersion () const
int	getMaintenanceVersion () const
bool	isDevelopmentVersion () const
const std::string	getLongVersionString () const
const std::string	getVersionString () const

Detailed Description

Definition at line 36 of file pvaVersion.h.

Constructor & Destructor Documentation

epics::pvAccess::Version::Version	(	std::string const &	productName,
		std::string const &	implementationLangugage,
		int	majorVersion,
		int	minorVersion,
		int	maintenanceVersion,
		bool	developmentFlag
	)

Default constructor.

Parameters

productName	product name.
implementationLangugage	implementation language.
majorVersion	major version.
minorVersion	minor version.
maintenanceVersion	maintenance version.
developmentFlag	development indicator flag.

Definition at line 23 of file pvaVersion.cpp.

                                                               :
    _productName(productName),
    _implementationLanguage(implementationLangugage),
    _majorVersion(majorVersion),
    _minorVersion(minorVersion),
    _maintenanceVersion(maintenanceVersion),
    _developmentFlag(developmentFlag)
{
}

Member Function Documentation

const std::string epics::pvAccess::Version::getImplementationLanguage

(

)

const

Implementation Language: C++

Definition at line 40 of file pvaVersion.cpp.

                                                         {
    return _implementationLanguage;
}

const std::string epics::pvAccess::Version::getLongVersionString

(

)

const

Get the long version string.

Returns

std::string denoting current version

int epics::pvAccess::Version::getMaintenanceVersion

(

)

const

Maintenance version number. Optional identifier used to designate maintenance drop applied to a specific release and contains fixes for defects reported. It maintains compatibility with the release and contains no API changes. When missing, it designates the final and complete development drop for a release.

Definition at line 52 of file pvaVersion.cpp.

                                         {
    return _maintenanceVersion;
}

int epics::pvAccess::Version::getMajorVersion

(

)

const

Major version number. This changes only when there is a significant, externally apparent enhancement from the previous release. 'n' represents the n'th version.

Clients should carefully consider the implications of new versions as external interfaces and behaviour may have changed.

Definition at line 44 of file pvaVersion.cpp.

                                   {
    return _majorVersion;
}

int epics::pvAccess::Version::getMinorVersion

(

)

const

Minor version number. This changes when:

• a new set of functionality is to be added
• API or behaviour change
• its designated as a reference release

Definition at line 48 of file pvaVersion.cpp.

                                   {
    return _minorVersion;
}

const std::string epics::pvAccess::Version::getProductName

(

)

const

The name of the product

Definition at line 36 of file pvaVersion.cpp.

                                              {
    return _productName;
}

const string epics::pvAccess::Version::getVersionString

(

)

const

Get the basic version string.

Returns

std::string denoting current version

Definition at line 60 of file pvaVersion.cpp.

                                             {
    stringstream ret;
    ret<<getProductName()<<" v"<<getMajorVersion()<<'.'<<getMinorVersion()<<'.'<<getMaintenanceVersion();
    if (isDevelopmentVersion())
        ret<<"-SNAPSHOT";

    return ret.str();
}

bool epics::pvAccess::Version::isDevelopmentVersion

(

)

const

Development flag.

Development drops are works in progress towards a completed, final release. A specific development drop may not completely implement all aspects of a new feature, which may take several development drops to complete. At the point of the final drop for the release, the -SNAPSHOT suffix will be omitted.

Definition at line 56 of file pvaVersion.cpp.

                                         {
    return _developmentFlag;
}

---

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

• modules/pvAccess/src/pva/pv/pvaVersion.h
• modules/pvAccess/src/pva/pvaVersion.cpp