pcl::PixInsightVersion Class Reference

Provides version information for the PixInsight core application. More...

#include <Version.h>

Public Member Functions
	PixInsightVersion ()=delete
	PixInsightVersion (const PixInsightVersion &)=delete
	~PixInsightVersion ()=delete
PixInsightVersion &	operator= (const PixInsightVersion &)=delete

Static Public Member Functions
static String	AsString (bool withCodename=false)
static int	BetaRelease ()
static int	Build ()
static String	Codename ()
static bool	Confidential ()
static String	LanguageCode ()
static bool	LE ()
static int	Major ()
static int	Minor ()
static int	Number ()
static int	Release ()
static int	Revision ()

Detailed Description

The PixInsightVersion class retrieves version data from the PixInsight core application where the current module has been installed.

Definition at line 166 of file Version.h.

Constructor & Destructor Documentation

PixInsightVersion() [1/2]

pcl::PixInsightVersion::PixInsightVersion ( )

delete

Default constructor. This constructor is disabled because PixInsightVersion is not an instantiable class.

PixInsightVersion() [2/2]

pcl::PixInsightVersion::PixInsightVersion ( const PixInsightVersion &  )

delete

Copy constructor. This constructor is disabled because PixInsightVersion is not an instantiable class.

~PixInsightVersion()

pcl::PixInsightVersion::~PixInsightVersion ( )

delete

Destructor. This destructor is disabled because PixInsightVersion is not an instantiable class.

Member Function Documentation

AsString()

static String pcl::PixInsightVersion::AsString ( bool  withCodename = false )

static

Returns a human-readable textual representation of the current PixInsight core version.

Parameters

withCodename

If this parameter is true, the returned version string will include the codename of the running PixInsight core application. The default value of this parameter is false.

BetaRelease()

static int pcl::PixInsightVersion::BetaRelease ( )

static

Returns the beta or release candidate version number of the PixInsight core application:

• Returns zero for a release version.
• Returns a positive nonzero integer for a beta version.
• Returns a negative integer for a release candidate (RC) version.

Build()

static int pcl::PixInsightVersion::Build ( )

static

Returns the build number of the PixInsight core application.

Deprecated:

Since core version 1.8.7 build numbers have been deprecated. They are maintained exclusively for compatibility with previous versions and existing code.

Codename()

static String pcl::PixInsightVersion::Codename ( )

static

Returns the codename for the current PixInsight core application version. Starting from version 1.7, each major PixInsight version is given a codename that uniquely identifies it.

Codename history:

PixInsight 1.7 Starbuck
PixInsight 1.8 Ripley

Confidential()

static bool pcl::PixInsightVersion::Confidential ( )

static

Returns true iff the PixInsight core is a confidential (pre-release) edition.

LanguageCode()

static String pcl::PixInsightVersion::LanguageCode ( )

static

Returns an ISO 639.2 language code that identifies the primary language of the PixInsight core application.

LE()

static bool pcl::PixInsightVersion::LE ( )

static

Returns true iff the PixInsight core is a limited edition (LE) release.

Major()

static int pcl::PixInsightVersion::Major ( )

static

Returns the major version number of the PixInsight core application.

Minor()

static int pcl::PixInsightVersion::Minor ( )

static

Returns the minor version number of the PixInsight core application.

Number()

static int pcl::PixInsightVersion::Number ( )

inlinestatic

Returns an integer that corresponds to the full PixInsight core version.

The returned value is equal to:

Major()*1000000 + Minor()*1000 + Release(); 

Definition at line 269 of file Version.h.

operator=()

PixInsightVersion& pcl::PixInsightVersion::operator= ( const PixInsightVersion &  )

delete

Copy assignment. This operator is disabled because PixInsightVersion is not an instantiable class.

Release()

static int pcl::PixInsightVersion::Release ( )

static

Returns the release version number of the PixInsight core application.

Revision()

static int pcl::PixInsightVersion::Revision ( )

static

Returns the revision version number of the PixInsight core application.

---

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

• Version.h