oaGuide.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaGuide.h
//
// This file contains the definition for the oaGuide class.
//
// The oaGuide class specifies a connection between two points that are
// intended to be wired together. Guides are generally placed into oaRoute
// objects when the wiring for a net is completed. Guides can be used before
// the detailed location of the wiring is known, but after the branching of the
// wire into segments for each end point is known.
//
// *****************************************************************************
// 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-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaGuide_P)
#define oaGuide_P



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



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



// *****************************************************************************
// oaGuide
// *****************************************************************************
class OA_DESIGN_DLL_API oaGuide : public oaConnFig {
public:
    static oaGuide          *create(oaBlock         *block,
                                    const oaPoint   &beginPoint,
                                    const oaPoint   &endPoint,
                                    oaLayerNum      beginLayer = oacAnyLayerNum,
                                    oaLayerNum      endLayer = oacAnyLayerNum);

    oaLayerHeader           *getBeginLayerHeader() const;
    oaLayerHeader           *getEndLayerHeader() const;
    void                    getPoints(oaPoint   &beginPoint,
                                      oaPoint   &endPoint) const;
    oaLayerNum              getBeginLayerNum() const;
    oaLayerNum              getEndLayerNum() const;
    oaRoute                 *getRoute() const;

    oaBoolean               hasRoute() const;
    oaBoolean               followLayers() const;

    void                    setPoints(const oaPoint &beginPoint,
                                      const oaPoint &endPoint);
    void                    setBeginLayerNum(oaLayerNum layer);
    void                    setEndLayerNum(oaLayerNum layer);
    void                    setFollowLayers(oaBoolean value);

    enum {dtIndex = oacGuideDataType};
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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