SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Member Functions | List of all members
smtk::common::VersionNumber Class Reference

A 2- or 3-component version number (i.e., major, minor, and optional patch). More...

#include <VersionNumber.h>

Inheritance diagram for smtk::common::VersionNumber:
[legend]
Collaboration diagram for smtk::common::VersionNumber:
[legend]

Public Member Functions

 VersionNumber ()
 Default constructor creates a nil VersionNumber (IsNull() == true).
 
 VersionNumber (const VersionNumber &other)
 Copy constructor.
 
 VersionNumber (int major, int minor=0, int patch=0)
 
 VersionNumber (const std::string &versionString)
 Construct a VersionNumber from a text string in either major.minor or major.minor.patch format.
 
int major () const
 
int minor () const
 
int patch () const
 
std::string string () const
 
bool isValid () const
 Returns true if the version number has been set; false otherwise. More...
 
VersionNumberoperator= (const VersionNumber &)=default
 

Detailed Description

A 2- or 3-component version number (i.e., major, minor, and optional patch).

Member Function Documentation

◆ isValid()

bool smtk::common::VersionNumber::isValid ( ) const

Returns true if the version number has been set; false otherwise.

Note that VersionNumber instances are initialized with a negative major version number that marks them as invalid.


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