oaTerm.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaTerm.h
//
// This file contains the definition for the oaTerm class and its public
// supporting class.
//
// The oaTerm class is an abstract base for all types of terminals. Terminals
// represent the logical connection points for a design. The pins associated
// with terminals represent the physical connection points. The nets associated
// with the terminals are logically exported through the terminals to the next
// higher level in a design hierarchy.
//
// Terminals are available to EMH as oaTerm in the block domain, oaModTerm in
// the module domain, and oaOccTerm in the occurrence domain.
//
// The supporting classes defined in this file include:
//
//  oaPinConnectMethod
//      This class implements an enumerated type that describes the pin
//      connection method associated with a terminal.
//
//  oaTermAttrType
//      This class implements support for displaying different term attributes
//      using a textDisplay object.
//
//  oaTermType
//      This class implements an enumerated type that describes the type of
//      an associated terminal.
//
//  oaRouteMethod
//      This class implements an enumerated type that describes the routing
//      method associated with various logical objects such as terminals, nets,
//      and instTerms.
//
//  oaTermArray
//  oaModTermArray
//  oaOccTermArray
//      These classes implement arrays of terminal pointers for the different
//      EMH domains.
//
// *****************************************************************************
// 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-2008 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaTerm_P)
#define oaTerm_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaAntennaData.h"
#include "oaNet.h"




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



// *****************************************************************************
// oaPinConnectMethodEnum
// *****************************************************************************
#define oavNumPinConnectMethodTypes     4

enum oaPinConnectMethodEnum {
    oacDefaultPinConnectMethod  = 0,
    oacRingPinConnectMethod     = 1,
    oacAbutPinConnectMethod     = 2,
    oacFeedthruPinConnectMethod = 3
};



// *****************************************************************************
// oaPinConnectMethod
// *****************************************************************************
class OA_DESIGN_DLL_API oaPinConnectMethod {
public:
                            oaPinConnectMethod(oaPinConnectMethodEnum valIn);
                            oaPinConnectMethod(const oaString &name);
                            ~oaPinConnectMethod();

#if !defined(OA_DEPRECATED)
    const oaString          &getName();
#endif

                            operator                oaPinConnectMethodEnum() const;

    const oaString          &getName() const;

private:
    oaPinConnectMethodEnum  value;

    static const oaString   names[];
};



// *****************************************************************************
// oaTermAttrTypeEnum
// *****************************************************************************
#define oavNumTermAttrTypes     3

enum oaTermAttrTypeEnum {
    oacNameTermAttrType     = 0,
    oacHasPinsTermAttrType  = 1,
    oacNumBitsTermAttrType  = 2
};



// *****************************************************************************
// oaTermAttrType
// *****************************************************************************
class OA_DESIGN_DLL_API oaTermAttrType : public oaAttrType {
public:
                            oaTermAttrType(oaTermAttrTypeEnum valueIn);
                            oaTermAttrType(const oaString &name);
                            oaTermAttrType(oaAttrType attr);

    virtual const oaString  &getName() const;

    oaTermAttrTypeEnum      getValue() const;

private:
    static const oaString   names[];
};



// *****************************************************************************
// oaTermTypeEnum
// *****************************************************************************
#define oavNumTermTypeEnums 7

enum oaTermTypeEnum {
    oacInputTermType        = 0,
    oacOutputTermType       = 1,
    oacInputOutputTermType  = 2,
    oacSwitchTermType       = 3,
    oacJumperTermType       = 4,
    oacUnusedTermType       = 5,
    oacTristateTermType     = 6
};



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

#if !defined(OA_DEPRECATED)
    const oaString          &getName();
#endif

                            operator                oaTermTypeEnum() const;

    const oaString          &getName() const;

private:
    oaTermTypeEnum          value;

    static const oaString   names[];
};



// *****************************************************************************
// oaRouteMethodEnum
// *****************************************************************************
#define oavNumRouteMethods 2

enum oaRouteMethodEnum {
    oacGeometricRouteMethod = 0,
    oacSymbolicRouteMethod  = 1
};



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

#if !defined(OA_DEPRECATED)
    const oaString          &getName();
#endif

                            operator                oaRouteMethodEnum() const;

    const oaString          &getName() const;

private:
    oaRouteMethodEnum       value;

    static const oaString   names[];
};



// *****************************************************************************
// Explicit template instantiations
// *****************************************************************************
#if defined(OA_DESIGN_DLL_EXTERN)
OA_DESIGN_DLL_EXTERN template
 class OA_DESIGN_DLL_API oaArray<oaTerm*>;

OA_DESIGN_DLL_EXTERN template
 class OA_DESIGN_DLL_API oaArray<oaModTerm*>;

OA_DESIGN_DLL_EXTERN template
 class OA_DESIGN_DLL_API oaArray<oaOccTerm*>;
#endif




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



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



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




// *****************************************************************************
// oaTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaTerm : public oaBlockObject {
public:
    static oaTerm                   *create(oaNet                   *net,
                                            const oaName            &name,
                                            oaTermType              termType = oacInputOutputTermType,
                                            oaBlockDomainVisibility view = oacInheritFromTopBlock);

    void                            destroy();

    static oaTerm                   *find(const oaBlock *block,
                                          const oaName  &name);
    static oaTerm                   *find(const oaBlock *block,
                                          oaUInt4       position);

    static oaBoolean                isValidName(const oaNet     *net,
                                                const oaName    &name);

    static oaUInt4                  getMaxPosition(const oaBlock *block);

    oaBoolean                       isImplicit() const;
    oaBoolean                       isInterface() const;

    oaNet                           *getNet(oaBoolean preferred = false) const;
    oaBitTerm                       *getBit(oaUInt4 bitIndex) const;
    oaUInt4                         getNumBits() const;
    oaTermType                      getTermType() const;
    oaUInt4                         getPosition() const;
    void                            getName(oaName &name) const;
    void                            getName(const oaNameSpace   &ns,
                                            oaString            &name) const;

    void                            moveToNet(oaNet *net);

    void                            setTermType(oaTermType termType);
    void                            setIsInterface(oaBoolean isInterface);

    void                            setPosition(oaUInt4 position);
    void                            unsetPosition();

    void                            scalarize();

    oaOccTerm                       *getOccTerm() const;

    oaCollection<oaPin, oaTerm>     getPins() const;
    oaCollection<oaRoute, oaTerm>   getConnRoutes() const;
    oaCollection<oaOccTerm, oaTerm> getOccTerms(const oaOccurrence *top) const;

    enum {dtIndex = oacTermDataType};
};



// *****************************************************************************
// oaBitTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaBitTerm : public oaTerm {
public:
    void                                getAntennaData(oaAntennaData    &data,
                                                       oaAntennaModel   model = oacDefaultAntennaModel) const;
    oaTermConnectDef                    *getConnectDef() const;
    oaBitTerm                           *getGroundSensitivity() const;
    oaPinConnectMethod                  getPinConnectMethod() const;
    oaRouteMethod                       getRouteMethod() const;
    oaBitTerm                           *getSupplySensitivity() const;

    void                                setMustJoin(const oaBitTerm *term);
    void                                unsetMustJoin();

    void                                setGroundSensitivity(const oaBitTerm *term);
    void                                setPinConnectMethod(oaPinConnectMethod method);
    void                                setRouteMethod(oaRouteMethod routeMethod);
    void                                setSupplySensitivity(const oaBitTerm *term);

    void                                setAntennaData(const oaAntennaData &data);
    void                                unsetAntennaData(oaAntennaModel model = oacDefaultAntennaModel);
    oaBoolean                           isAntennaDataSet(oaAntennaModel model = oacDefaultAntennaModel) const;

    void                                hide();

    oaCollection<oaBitTerm, oaBitTerm>  getMustJoinTerms() const;
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaTerm> {
public:
    typedef oaBlockObject       parentType;
    typedef oaTermModTypeEnum   modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {isMultiDomain = true};
    enum {dtIndex = oacTermDataType};
    enum {dataTypeEnumVal = oacTermDataType};
    enum {abstractTypeEnumVal = oacTermType};
};

template<>
class oaTraits<oaBitTerm> {
public:
    typedef oaTermModTypeEnum   modTypeType;
    typedef oaTerm              parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacTermDataType};
    enum {dataTypeEnumVal = oacTermDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = false};
    enum {abstractTypeEnumVal = oacBitTermType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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