oaBuildInfo Class Reference


Public Methods

 oaBuildInfo (const oaString &packageNameIn, const oaString &buildNameIn, const oaString &buildTimeIn, oaUInt4 buildNumberIn, oaUInt4 majorReleaseNum=OA_MAJOR_RELEASE_NUM, oaUInt4 minorReleaseNum=OA_MINOR_RELEASE_NUM)
const oaString & getPackageName () const
const oaString & getBuildName () const
const oaString & getBuildTime () const
oaUInt4 getBuildNumber () const
oaUInt4 getMajorReleaseNum () const
oaUInt4 getMinorReleaseNum () const

Static Public Methods

oaBuildInfo * find (const oaString &packageName)
void getPackages (oaBuildInfoArray &packagesIn)
oaBuildInfo ** getPackages ()
oaUInt4 getNumPackages ()
const oaString getPlatformName ()
const oaString & getAppBuildName ()

Detailed Description

The oaBuildInfo class implements a utility class for registering and querying build information for libraries and executables. When OpenAccess is built, each library and executable registers its own oaBuildInfo object. Applications can query by name for a specific oaBuildInfo object or can get the list of all registered packages.

The build process defines the build name, time, and number, which helps identify the OpenAccess code in use. This information can be important when considering data compatibility. See Compatibility for OpenAccess Applications and Data in the Programmers Guide for more information.

Constructor & Destructor Documentation

oaBuildInfo::oaBuildInfo (  const oaString &    packageName,
const oaString &    buildName,
const oaString &    buildTime,
oaUInt4    buildNumber,
oaUInt4    majorReleaseNum = OA_MAJOR_RELEASE_NUM,
oaUInt4    minorReleaseNum = OA_MINOR_RELEASE_NUM
) 
 

This is the constructor for the oaBuildInfo object. It initializes the oaBuildInfo object with the specified values and adds it to the list of build packages.

Parameters:
packageName The name of the library or executable
buildName The name of the build as assigned by OpenAccess, for example, "p014"
buildTime The build time string as assigned by OpenAccess, for example, "Sun Jun 6 12:08 2004"
buildNumber The build number as assigned by OpenAccess, for example, 14
majorReleaseNum An optional value specifying the major release number. The default value is the current OpenAccess major release value.
minorReleaseNum An optional value specifying the minor release number. The default value is the current OpenAccess minor release value.

Member Function Documentation

oaBuildInfo * oaBuildInfo::find (  const oaString &    packageName )  [static]
 

This function searches the list of build packages for a package with the specified name. NULL is returned if no such package is registered.

Parameters:
packageName The name of the build package to find.

const oaString & oaBuildInfo::getAppBuildName (    )  [static]
 

This function returns the OpenAccess build name that the application is compiled against.

const oaString & oaBuildInfo::getBuildName (    )  const [inline]
 

This function returns the build name associated with this oaBuildInfo object.

oaUInt4 oaBuildInfo::getBuildNumber (    )  const [inline]
 

This function returns the build number associated with this oaBuildInfo object.

const oaString & oaBuildInfo::getBuildTime (    )  const [inline]
 

This function returns the build time string associated with this oaBuildInfo object.

oaUInt4 oaBuildInfo::getMajorReleaseNum (    )  const [inline]
 

This function returns the major release number associated with this oaBuildInfo object.

oaUInt4 oaBuildInfo::getMinorReleaseNum (    )  const [inline]
 

This function returns the minor release number associated with this oaBuildInfo object.

oaUInt4 oaBuildInfo::getNumPackages (    )  [inline, static]
 

This function returns the number of registered build packages.

const oaString & oaBuildInfo::getPackageName (    )  const [inline]
 

This function returns the package name associated with this oaBuildInfo object.

oaBuildInfo ** oaBuildInfo::getPackages (    )  [inline, static]
 

This function returns a pointer to the list of registered packages that have registered build information. This list can be traversed as follows: 

       oaBuildInfo **packages = oaBuildInfo::getPackages();

       for (oaUInt4 i = 0; i < oaBuildInfo::getNumPackages(); i++) {
           oaBuildInfo *pkg = packages[i];
           ...
        }

void oaBuildInfo::getPackages (  oaBuildInfoArray &    packagesIn )  [inline, static]
 

This function returns the array of oaBuildInfo pointers stored by this class.

Parameters:
packagesIn The array of oaBuildInfo pointers in which to return the list of packages.

const oaString oaBuildInfo::getPlatformName (    )  [inline, static]
 

This static function returns the platform name string associated with this oaBuildInfo object.

For a complete list of the OpenAccess supported platforms, refer to the OpenAccess 2.2 Installation and Configuration Notes.

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

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.