Package autodesk_toxik :: Module init :: Class BuildInfo

Class BuildInfo

 object --+    
          |    
Boost.Python.instance --+
              |
             BuildInfo

Object that contains various pieces of information about the build. You can access the read-only properties described below.

Nested Classes
	VersionFormat

Instance Methods

__init__(...)
Raises an exception This class cannot be instantiated from Python

__reduce__(...)
helper for pickle

str

getBuildDate(...)
Returns: The build date.

str

getBuildInformationString(...)
The build information string.

str

getBuildOptions(...)
Returns: The build options that were used.

str

getBuildStamp(...)
Returns: The build stamp.

str

getComponentName(...)
Returns: The component name string.

int

getMajorVersion(...)
Returns: The major version number of the version string.

int

getMinorVersion(...)
Returns: The minor version number of the version string.

str

getPhase(...)
Returns: A str indicating the development phase of the release of the software.

str

getProductName(...)
Returns: The product name.

str

getVersion(...)
Returns: The version in the specified format.

str

getVersionNumber(...)
Returns: The version number ('2.0') that uniquely identifies the release version being developped (no phase).

str

getVersionStatus(...)
Returns: The version status indicates whether this is a development build, a build shipped to alpha customers, a build shipped to beta customers or a release build.

str

getVersionString(...)
Returns: The version string.

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

getBuildDate(...)

Returns: str: The build date.

getBuildInformationString(...)

The build information string. This is a single line that identifies this build. For instance, "Debug WinNT Pentium IV Internal Build #612". This string also appears in the About screen. It is the concatenation of the build options and the stamp.

Returns: str: The build information string.

getBuildOptions(...)

Returns: str: The build options that were used.

getBuildStamp(...)

Returns: str: The build stamp.

getComponentName(...)

Returns: str: The component name string. For libraries, this is the name of the library (e.g. "resmgt").

getMajorVersion(...)

Returns: int: The major version number of the version string.

getMinorVersion(...)

Returns: int: The minor version number of the version string.

getPhase(...)

Returns: str: A str indicating the development phase of the release of the software. An empty string indicates a released version. Other strings (a1, a2, b1, b2, RC1, RC2, etc.) indicate alpha, beta and release candidate versions.

getProductName(...)

Returns: str: The product name. (eg. 'Toxik'). This is the complete name of the product to which the version information applies.

getVersion(...)

Parameters:

versionFormat - A value of the BuildInfo.VersionFormat enumeration:
- BuildInfo.VersionFormat.VERSION_AS_STRING
- BuildInfo.VersionFormat.VERSION_AS_NUMBERS
If versionFormat is set to VERSION_AS_NUMBERS, getVersion() returns the numerical version number, including the phase if any (for example: "2.0", "2.0b2") .If versionFormat is set to VERSION_AS_STRING, getVersion() returns the version string, including the phase if any (for example: "2007", "2007b2")

Returns: str

The version in the specified format.

getVersionNumber(...)

Returns: str: The version number ('2.0') that uniquely identifies the release version being developped (no phase). This contains, normally, the main and minor version number, but could also include other information, such as extensions ('2.0x1') and QFES ('2.0.0.1').

getVersionStatus(...)

Returns: str: The version status indicates whether this is a development build, a build shipped to alpha customers, a build shipped to beta customers or a release build.

getVersionString(...)

Returns: str: The version string. (eg. '2010'). It uniquely identifies the release version being developped (no phase), for marketing purposes.

Class BuildInfo

__init__(...) (Constructor)

__reduce__(...)

getBuildDate(...)

getBuildInformationString(...)

getBuildOptions(...)

getBuildStamp(...)

getComponentName(...)

getMajorVersion(...)

getMinorVersion(...)

getPhase(...)

getProductName(...)

getVersion(...)

getVersionNumber(...)

getVersionStatus(...)

getVersionString(...)

init(...)
(Constructor)

reduce(...)