oaPin.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPin.h
//
// This file contains the definition for the oaPin class. A oaPin implements an
// object that represents the physical connections of terminals to nets.
//
// *****************************************************************************
// 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(oaPin_P)
#define oaPin_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaInst.h"



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



// *****************************************************************************
// Access Direction Bits
// *****************************************************************************
#define oacNone         0x0000u
#define oacTop          0x0001u
#define oacBottom       0x0002u
#define oacLeft         0x0004u
#define oacRight        0x0008u



// *****************************************************************************
// oaPinTypeEnum
// *****************************************************************************
#define oavNumPinTypes      3

enum oaPinTypeEnum {
    oacNonePinType  = 0,
    oacCorePinType  = 1,
    oacBumpPinType  = 2
};



// *****************************************************************************
// oaPinType
// *****************************************************************************
class OA_DESIGN_DLL_API oaPinType {
public:
                            oaPinType(oaPinTypeEnum valueIn);
                            oaPinType(const oaString &name);
                            ~oaPinType();

                            operator                oaPinTypeEnum() const;

    const oaString          &getName() const;

private:
    static const oaString   *initNames();

    static const oaString   *names;
    oaPinTypeEnum           value;
};



// *****************************************************************************
// oaPin
// *****************************************************************************
class OA_DESIGN_DLL_API oaPin : public oaBlockObject {
public:
    static oaPin                    *create(oaTerm  *term,
                                            oaUInt4 accessDir = oacNone);
    static oaPin                    *create(oaTerm          *term,
                                            const oaString  &name,
                                            oaUInt4         accessDir = oacNone);

    void                            destroy();

    static oaPin                    *find(const oaTerm      *term,
                                          const oaString    &name);

    oaTerm                          *getTerm() const;
    void                            getName(oaString &name) const;
    oaUInt4                         getAccessDir() const;
    oaPlacementStatus               getPlacementStatus() const;
    oaPinType                       getPinType() const;

    void                            setTerm(oaTerm *term);
    void                            setName(const oaString &name);
    void                            setAccessDir(oaUInt4 accessDir);
    void                            setPlacementStatus(oaPlacementStatus status);
    void                            setPinType(oaPinType pinType);

    oaCollection<oaPinFig, oaPin>   getFigs() const;
    oaCollection<oaRoute, oaPin>    getConnRoutes() const;

    enum {dtIndex = oacPinDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaPin> {
public:
    typedef oaBlockObject       parentType;
    typedef oaPinModTypeEnum    modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPinType};
    enum {dtIndex = oacPinDataType};
    enum {dataTypeEnumVal = oacPinDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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