HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SdfFileVersion Class Reference

#include <fileVersion.h>

Public Member Functions

constexpr SdfFileVersion ()
 
constexpr SdfFileVersion (uint8_t majver, uint8_t minver, uint8_t patchver)
 
 SdfFileVersion (const uint8_t version[])
 
constexpr uint32_t AsInt () const
 
SDF_API std::string AsString () const
 
SDF_API std::string AsFullString () const
 
bool IsValid () const
 Return true if this version is not zero in all components. More...
 
 operator bool () const
 
bool CanRead (SdfFileVersion const &fileVer) const
 
bool CanWrite (SdfFileVersion const &fileVer) const
 
 LOGIC_OP (==)
 
 LOGIC_OP (!=)
 
 LOGIC_OP (<)
 
 LOGIC_OP (>)
 
 LOGIC_OP (<=)
 
 LOGIC_OP (>=)
 

Static Public Member Functions

static SDF_API SdfFileVersion FromString (char const *str)
 Create a version from a dot-separated c-style string, e.g. "1.2.3". More...
 
static SdfFileVersion FromString (std::string str)
 Create a version from a dot-separated std::string. More...
 

Public Attributes

uint8_t majver
 
uint8_t minver
 
uint8_t patchver
 

Detailed Description

Definition at line 21 of file fileVersion.h.

Constructor & Destructor Documentation

constexpr SdfFileVersion::SdfFileVersion ( )
inline

Definition at line 26 of file fileVersion.h.

constexpr SdfFileVersion::SdfFileVersion ( uint8_t  majver,
uint8_t  minver,
uint8_t  patchver 
)
inline

Definition at line 29 of file fileVersion.h.

SdfFileVersion::SdfFileVersion ( const uint8_t  version[])
inlineexplicit

Definition at line 34 of file fileVersion.h.

Member Function Documentation

SDF_API std::string SdfFileVersion::AsFullString ( ) const

Return a dotted decimal integer string for this version, the patch version is excluded if it is 0, e.g. "1.0.0" or "1.2.3".

constexpr uint32_t SdfFileVersion::AsInt ( ) const
inline

Return a version number as a single 32-bit integer. From most to least significant, the returned integer's bytes are 0, major-version, minor-version, patch-version.

Definition at line 49 of file fileVersion.h.

SDF_API std::string SdfFileVersion::AsString ( ) const

Return a dotted decimal integer string for this version, the patch version is excluded if it is 0, e.g. "1.0" or "1.2.3".

bool SdfFileVersion::CanRead ( SdfFileVersion const &  fileVer) const
inline

Definition at line 76 of file fileVersion.h.

bool SdfFileVersion::CanWrite ( SdfFileVersion const &  fileVer) const
inline

Definition at line 83 of file fileVersion.h.

static SDF_API SdfFileVersion SdfFileVersion::FromString ( char const *  str)
static

Create a version from a dot-separated c-style string, e.g. "1.2.3".

static SdfFileVersion SdfFileVersion::FromString ( std::string  str)
inlinestatic

Create a version from a dot-separated std::string.

Definition at line 42 of file fileVersion.h.

bool SdfFileVersion::IsValid ( ) const
inline

Return true if this version is not zero in all components.

Definition at line 66 of file fileVersion.h.

SdfFileVersion::LOGIC_OP ( )
SdfFileVersion::LOGIC_OP ( !  )
SdfFileVersion::LOGIC_OP ( )
SdfFileVersion::LOGIC_OP ( )
SdfFileVersion::LOGIC_OP ( >=  )
SdfFileVersion::LOGIC_OP ( <=  )
SdfFileVersion::operator bool ( ) const
inlineexplicit

Definition at line 68 of file fileVersion.h.

Member Data Documentation

uint8_t SdfFileVersion::majver

Definition at line 24 of file fileVersion.h.

uint8_t SdfFileVersion::minver

Definition at line 24 of file fileVersion.h.

uint8_t SdfFileVersion::patchver

Definition at line 24 of file fileVersion.h.

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