oaBuildInfo.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaBuildInfo.h
//
// This file contains the definition of the oaBuildInfo class. The oaBuildInfo
// class implements a utility class for registering and querying build
// information for libraries and executables.
//
// The following information is currently stored in the buildInfo:
//
//  packageName     - The name of the library or executable
//  buildName       - The build name, e.g., "a014"
//  buildTime       - The build time as a string, e.g., "Sun Jun  6 12:08 2004"
//  buildNumber     - The build number, e.g., 14
//  majorReleaseNum - The major release number, e.g., 2
//  minorReleaseNum - The minor release number, e.g., 2
//
// The oaBuildInfoArray class implements a utility array class used to pass
// an array of oaBuildInfo pointers back to the user via 
// oaBuildInfo::getPackages().
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2004-2006 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #4 $
//  $Date: 2010/09/07 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaBuildInfo_P)
#define oaBuildInfo_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"
#include "oaArray.h"
#include "oaBuildDef.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
class oaBuildInfo;
class oaBuildInfoArray;



// *****************************************************************************
// oaBuildInfo
// *****************************************************************************
class OA_BASE_DLL_API oaBuildInfo {
public:
                            oaBuildInfo(const oaString  &packageNameIn,
                                        const oaString  &buildNameIn,
                                        const oaString  &buildTimeIn,
                                        oaUInt4         buildNumberIn,
                                        oaUInt4         majorReleaseNum = OA_MAJOR_RELEASE_NUM,
                                        oaUInt4         minorReleaseNum = OA_MINOR_RELEASE_NUM);

    static oaBuildInfo      *find(const oaString &packageName);

    static void             getPackages(oaBuildInfoArray &packagesIn);
#if !defined(OA_DEPRECATED)
    static oaBuildInfo      **getPackages();
#endif
    static oaUInt4          getNumPackages();
    static const oaString   getPlatformName();
    static const oaString   &getAppBuildName();

    const oaString          &getPackageName() const;
    const oaString          &getBuildName() const;
    const oaString          &getBuildTime() const;
    oaUInt4                 getBuildNumber() const;
    oaUInt4                 getMajorReleaseNum() const;
    oaUInt4                 getMinorReleaseNum() const;

private:
    oaString                packageName;
    oaString                buildName;
    oaString                buildTime;
    oaUInt4                 buildNumber;
    oaUInt4                 majorRelNum;
    oaUInt4                 minorRelNum;

    static oaUInt4          numPackages;
    static oaUInt4          packageArraySize;
    static oaBuildInfo      **packages;
    static const oaString   platformName;
};



// *****************************************************************************
// oaBuildInfoArray
// *****************************************************************************
class OA_BASE_DLL_API oaBuildInfoArray : public oaArray<oaBuildInfo*> {
public:
                            oaBuildInfoArray(oaUInt4 sizeIn = 0);

    using                   oaArray<oaBuildInfo*>::sort;
    void                    sort();
};



END_OA_NAMESPACE

#endif

Return to top of page

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