oaRoute.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaRoute.h
//
// This file contains the definition for the oaRoute class and its public
// supporting classes. The oaRoute class implements a connection (physical, 
// logical, or both) from one point to another. The supporting classes include:
//
//  oaRouteObjectArray
//      This class implements an array of figure pointers used with routes.
//
// *****************************************************************************
// 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 2003-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaRoute_P)
#define oaRoute_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaFig.h"
#include "oaBlock.h"



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



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



// *****************************************************************************
// oaRoute
// *****************************************************************************
class OA_DESIGN_DLL_API oaRoute : public oaConnFig {
public:
    static oaRoute          *create(oaBlock         *block,
                                    oaNet           *net = NULL,
                                    oaBoolean       isGlobal = false,
                                    oaRouteStatus   stat = oacNormalRouteStatus);

    oaRouteStatus           getRouteStatus() const;
    oaBlockObject           *getBeginConn() const;
    oaBlockObject           *getEndConn() const;
    oaUInt4                 getNumObjects() const;
    void                    getObjects(oaRouteObjectArray &objects) const;

    oaBoolean               isGlobal() const;
    oaBoolean               isContiguous() const;
    oaBoolean               hasGuide() const;

    oaBoolean               hasDefaultConstraintGroup() const;
    oaConstraintGroup       *getDefaultConstraintGroup() const;

    void                    setRouteStatus(const oaRouteStatus &routeStatus);
    void                    setBeginConn(oaBlockObject *object);
    void                    setEndConn(oaBlockObject *object);
    void                    setGlobal(oaBoolean global);
    void                    setObjects(const oaRouteObjectArray &objects);

    void                    unsetBeginConn();
    void                    unsetEndConn();
    void                    unsetObjects();
    void                    destroyObjects();

    enum {dtIndex = oacRouteDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaRoute> {
public:
    typedef oaConnFig           parentType;
    typedef oaRouteModTypeEnum  modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacRouteDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacRouteType};
    enum {dataTypeEnumVal = oacRouteDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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