oaAnalysisPoint.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaAnalysisPoint.h
//
// This file contains the definition for the oaAnalysisPoint class, which
// represents a set of oaAnalysisOpPoints.  Each oaAnalysisOpPoint corresponds
// to a oaOpPoint used for analysis of some of the instances in the design.
// Collectively those oaOpPoints allow a consistent analysis (such as best-case
// or worst-case) across the whole design.
//
// The oaAnalysisPointArray class implements a utility array class used to
// pass an array of oaAnalysisPoint class pointers to 
// oaParasiticNetwork::create().
//
// *****************************************************************************
// 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 2002-2006 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaAnalysisPoint_P)
#define oaAnalysisPoint_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaDesignModTypes.h"
#include "oaDesign.h"



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



// *****************************************************************************
// oaAnalysisPoint
// *****************************************************************************
class OA_DESIGN_DLL_API oaAnalysisPoint : public oaDesignObject {
public:
    static oaAnalysisPoint                              *create(oaDesign        *design,
                                                                const oaString  &name);

    static oaAnalysisPoint                              *find(const oaDesign    *design,
                                                              const oaString    &name);

    void                                                destroy();

    void                                                setName(const oaString &name);
    void                                                getName(oaString &name) const;

    oaCollection<oaAnalysisOpPoint, oaAnalysisPoint>    getAnalysisOpPoints() const;

    enum {dtIndex = oacAnalysisPointDataType};
    enum {domain = oacNoDomain};
};



// *****************************************************************************
// oaAnalysisPointArray
// *****************************************************************************
class OA_DESIGN_DLL_API oaAnalysisPointArray : public oaArray<oaAnalysisPoint*> {
public:
                            oaAnalysisPointArray(oaUInt4 sizeIn = 0);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaAnalysisPoint> {
public:
    typedef oaDesignObject              parentType;
    typedef oaAnalysisPointModTypeEnum  modTypeType;
    enum {dbType = oacDesignDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacAnalysisPointDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAnalysisPointType};
    enum {dataTypeEnumVal = oacAnalysisPointDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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