Common Fluids Format 2025 R1

ansys::CffVersion Class Reference

Last update: 19.05.2025

Provides some basic version extraction and comparison functions. More...

#include "CffInterface/CffVersion.hpp"

Inheritance diagram for ansys::CffVersion:
ansys::CffBaseansys::CffConsumeransys::CffProvideransys::CffFileConsumeransys::CffFileProvider

Public Member Functions

 CffVersion ()
 
 ~CffVersion ()
 

Static Public Member Functions

static unsigned int getMajor ()
 
static unsigned int getMinor ()
 
static unsigned int getPatch ()
 
static std::string getSHA ()
 
static bool isBeta ()
 
static std::string apiVersionAsString (const std::string &separator=".")
 
static std::string ansysApplicationVersion (const std::string &appName)
 
static std::string copyright (bool allRightsReserved)
 

Detailed Description

Provides some basic version extraction and comparison functions.

Constructor & Destructor Documentation

◆ CffVersion()

ansys::CffVersion::CffVersion ( )
inline

◆ ~CffVersion()

ansys::CffVersion::~CffVersion ( )
inline

Member Function Documentation

◆ ansysApplicationVersion()

std::string ansys::CffVersion::ansysApplicationVersion ( const std::string &  appName)
static

Returns the version of the API including an application name Primarily this is for use when writing release information to a file

◆ apiVersionAsString()

std::string ansys::CffVersion::apiVersionAsString ( const std::string &  separator = ".")
static

Returns the version of the API as string in the form: <MAJOR><separator><MINOR>[<separator><PATCH>]

◆ copyright()

std::string ansys::CffVersion::copyright ( bool  allRightsReserved)
static

Returns a copyright string containing the ANSYS copyright information

◆ getMajor()

unsigned int ansys::CffVersion::getMajor ( )
static

Returns the major release version of the API

◆ getMinor()

unsigned int ansys::CffVersion::getMinor ( )
static

Returns the minor release version of the API

◆ getPatch()

unsigned int ansys::CffVersion::getPatch ( )
static

Returns the path release version of the API

◆ getSHA()

std::string ansys::CffVersion::getSHA ( )
static

Returns the unique SHA index of the API

◆ isBeta()

bool ansys::CffVersion::isBeta ( )
static

Returns whether this version of the API is at Beta release level

Connect with Ansys