RhinoVersion Class Reference

#include <rhinoSdkRhinoVersion.h>

Static Public Member Functions
static unsigned int	App3dmVersionNumber ()
static const char *	AppNameString ()
static const wchar_t *	AppNameWideString ()
static unsigned int	AppSdkServiceReleaseNumber ()
static unsigned int	AppSdkVersionNumber ()
static unsigned int	AppVersionNumber ()
static unsigned int	Branch ()
static const char *	BuildDescriptionString ()
static unsigned int	DayOfMonth ()
static unsigned int	DayOfYear ()
static unsigned int	GetVersionQuartet (unsigned int rhino_version_quartet[4])
static unsigned int	GetVersionQuartet (unsigned short rhino_version_quartet[4])
static unsigned int	Hour ()
static unsigned int	Major ()
static const char *	MajorString ()
static const wchar_t *	MajorWideString ()
static unsigned int	Minor ()
static unsigned int	Minute ()
static unsigned int	Month ()
static const char *	RegistryRootString ()
static const wchar_t *	RegistryRootWideString ()
static const char *	ServiceReleaseString ()
static const wchar_t *	ServiceReleaseWideString ()
static const char *	VersionQuartetString ()
static const wchar_t *	VersionQuartetWideString ()
static unsigned int	Year ()

Detailed Description

This file defines the RhinoVersion class which provides runtime access to Rhinoceros application version information. The RhinoVersion class is part ov the public SDK and is available for use in an C++ Rhino code, plug-in code or library code.

In the rare case that you actually want the C++ prerpocessor defines for this version information, you need to explicitly include rhinoSdkVersion.h. Description: The static functions in the RhinoVersion class provide complete runtime version information about the Rhino.exe application that is running.

Member Function Documentation

App3dmVersionNumber()

static unsigned int RhinoVersion::App3dmVersionNumber ( )

static

Returns: The version number of the 3dm file format the Rhino.exe application writes by default. Remarks:

• For public release, service release and public WIP versions of Rhino, this number is identical to RhinoVersion::Major().
• When a new version of Rhino is in "alpha", this version number may be RhinoVersion::Major()-1 during the time it takes to get all application and IO code synchronized.

AppNameString()

static const char* RhinoVersion::AppNameString ( )

static

AppNameWideString()

static const wchar_t* RhinoVersion::AppNameWideString ( )

static

Returns: The application name this version.
For example, "Rhinoceros 6"

AppSdkServiceReleaseNumber()

static unsigned int RhinoVersion::AppSdkServiceReleaseNumber ( )

static

Returns: The version number of the Rhino.exe application sdk service release in the form used to identify opennurbs and Rhino SDK versions. Remarks:

• RhinoVersion::AppSdkVersionNumber() <= RhinoVersion::AppSdkServiceReleaseNumber()
• RhinoVersion::AppSdkServiceReleaseNumber() <= RhinoVersion::AppVersionNumber() (typically == in public release builds)
• In order for a plug-in to load, the plug-ins sdk service release must be <= RhinoVersion::AppSdkServiceReleaseNumber(). RhinoVersion::AppSdkServiceReleaseNumber() >= RhinoVersion::AppSdkVersionNumber().

AppSdkVersionNumber()

static unsigned int RhinoVersion::AppSdkVersionNumber ( )

static

Returns: The version number of the Rhino.exe application sdk in the form used to identify opennurbs and Rhino SDK versions. Remarks:

• RhinoVersion::AppSdkVersionNumber() <= RhinoVersion::AppSdkServiceReleaseNumber()
• RhinoVersion::AppSdkServiceReleaseNumber() <= RhinoVersion::AppVersionNumber() (typically == in public release builds)
• In order for a plug-in to load, the values of plug-in's sdk version number and RhinoVersion::AppSdkVersionNumber() must be identical.
• RhinoVersion::AppSdkVersionNumber() = ON_VersionNumberConstruct( RhinoVersion::Major(), minor, year,month,day_of_month,branch ); where minor,year,month,day_of_month,branch are the values of the version information on the day the sdk for this version of Rhino was "frozen".

AppVersionNumber()

static unsigned int RhinoVersion::AppVersionNumber ( )

static

Returns: The version number of the Rhino.exe application in the form used to identify opennurbs and Rhino SDK versions. Remarks:

• RhinoVersion::AppSdkVersionNumber() <= RhinoVersion::AppSdkServiceReleaseNumber()
• RhinoVersion::AppSdkServiceReleaseNumber() <= RhinoVersion::AppVersionNumber() (typically == in public release builds)
• RhinoVersion::AppVersionNumber() = ON_VersionNumberConstruct( RhinoVersion::Major(), RhinoVersion::Minor(), RhinoVersion::Year(), RhinoVersion::Month(), RhinoVersion::DayOfMonth(), RhinoVersion::Branch() );

Branch()

static unsigned int RhinoVersion::Branch ( )

static

Returns: RHINO_VERSION_BRANCH 0: developer build 1: Windows Commercial build 2: Mac Commercial build 3: Windows BETA build 4: Mac Beta build 5: Windows WIP build 6: Mac WIP build

BuildDescriptionString()

static const char* RhinoVersion::BuildDescriptionString ( )

static

Returns: A string that describes the build. For a public build, this is something like "Release". For a developer build, this is something like "Private Developer Build".

DayOfMonth()

static unsigned int RhinoVersion::DayOfMonth ( )

static

Returns: Day of the month this version was built (1 to 31).

DayOfYear()

static unsigned int RhinoVersion::DayOfYear ( )

static

Returns: Day of the year this version was built (1 to 366).

GetVersionQuartet() [1/2]

static unsigned int RhinoVersion::GetVersionQuartet ( unsigned int  rhino_version_quartet[4] )

static

Parameters: rhino_version_quartet - [out] rhino_version_quartet[0] = major version number rhino_version_quartet[1] = minor version number rhino_version_quartet[2] = (year-2000)*1000 + (day of year) rhino_version_quartet[3] = hour*1000 + minute*10 + branch Returns: RhinoVersion::AppVersionNumber()

GetVersionQuartet() [2/2]

static unsigned int RhinoVersion::GetVersionQuartet ( unsigned short  rhino_version_quartet[4] )

static

Parameters: rhino_version_quartet - [out] rhino_version_quartet[0] = major version number rhino_version_quartet[1] = minor version number rhino_version_quartet[2] = (year-2000)*1000 + (day of year) rhino_version_quartet[3] = hour*1000 + minute*10 + branch Returns: RhinoVersion::AppVersionNumber()

Hour()

static unsigned int RhinoVersion::Hour ( )

static

Returns: Hour of the day this version was built (0 to 23).

Major()

static unsigned int RhinoVersion::Major ( )

static

Returns: Major version number (>=6) For example, 6 for Rhino 6.x.

MajorString()

static const char* RhinoVersion::MajorString ( )

static

MajorWideString()

static const wchar_t* RhinoVersion::MajorWideString ( )

static

Returns: The value of VersionMajor() as a string.

Minor()

static unsigned int RhinoVersion::Minor ( )

static

Returns: Minor version number (>= 0) For example, 1 for Rhino 6.1

Minute()

static unsigned int RhinoVersion::Minute ( )

static

Returns: Minute of the hour this version was built (0 to 59).

Month()

static unsigned int RhinoVersion::Month ( )

static

Returns: Month of the year this version was built (1 to 12).

RegistryRootString()

static const char* RhinoVersion::RegistryRootString ( )

static

RegistryRootWideString()

static const wchar_t* RhinoVersion::RegistryRootWideString ( )

static

Returns: The registry root for this version.
For example, "McNeel\\Rhinoceros\\6.0"

ServiceReleaseString()

static const char* RhinoVersion::ServiceReleaseString ( )

static

ServiceReleaseWideString()

static const wchar_t* RhinoVersion::ServiceReleaseWideString ( )

static

Returns: "SRn" for service release n, where n is an integer. For example, the "SR1" will be returned for service release 1.

VersionQuartetString()

static const char* RhinoVersion::VersionQuartetString ( )

static

VersionQuartetWideString()

static const wchar_t* RhinoVersion::VersionQuartetWideString ( )

static

Returns: The version quartet as string of four values separated by periods. For example, "6,0,14065,18590" would be version 6, service release 0, built on 18:19, day 65, year 2014. The final digit identifies the branch.

Year()

static unsigned int RhinoVersion::Year ( )

static

Returns: Year this version was built. ( >= 2014)