Itasca C++ Interface
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
itasca::IIdent Class Referenceabstract

Central class for information identifying the particular program using the kernel library. More...

#include <iident.h>

Public Types

enum class  CodeType {
  Release =0 , Alpha =1 , Beta =2 , PreRelease =3 ,
  NewVersionAvailable =4 , Unsupported =5
}
 Possible code types. More...
 

Public Member Functions

virtual IString getDefaultFileName () const =0
 
virtual IString getVersionString () const =0
 Returns a text string with full version information. Like "3.10 Beta 453".
 
virtual IString getRegistryString () const =0
 QString to place persistant storage under. "flac3d400".
 
virtual IString getBranch () const =0
 This returns a string identifying what branch this code is under, if any.
 
virtual CodeType getCodeType () const =0
 For instance, the '3dec' in the extension '3decsav'.
 
virtual Version getCodeVersion () const =0
 

Detailed Description

Central class for information identifying the particular program using the kernel library.

Member Enumeration Documentation

◆ CodeType

enum class itasca::IIdent::CodeType
strong

Possible code types.

Enumerator
Release 

Release code. Available for purchase.

Alpha 

Alpha code. In active development, may change at any time, no guaranteed of future file compatibility.

Beta 

Beta code. Feature complete, being tested internally to Itasca.

PreRelease 

Pre-Release code. Feature complete, partially documented, being tested internally and externally by pre-purchasers

NewVersionAvailable 

The next version has been made available. This version is still supported for now. Customers should upgrade.

Unsupported 

This version is no longer officially supported. Upgrade to the latest version

Member Function Documentation

◆ getCodeType()

virtual CodeType itasca::IIdent::getCodeType ( ) const
pure virtual

For instance, the '3dec' in the extension '3decsav'.

Returns the current code status - alpha, beta, or release.

◆ getDefaultFileName()

virtual IString itasca::IIdent::getDefaultFileName ( ) const
pure virtual

Returns the default file name (without extension) for files from this program. Like "flac3d".


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