oaConnectDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaConnectDef.h
//
// This file contains the definition of the oaConnectDef class, its derived
// classes, and its public supporting classes. The oaConnectDef class is an
// abstract base for all types of connection definitions. A connection
// definition associates an assignment definition (an oaAssignmentDef) with
// either a net or a terminal.
//
// The oaConnectDef classes together with the oaAssignment classes provide users
// a way to override the name of the net used in the associated connection.
//
// The derived classes of oaConnectDef include:
//
//  oaNetConnectDef
//      This class implements a connectDef that associates an oaAssignmentDef
//      with a single-bit net. Applications traversing connectivity search up
//      the design hierarchy for an oaAssignment that has the lookup name
//      specified in the assignment definition. If an oaAssignment is found,
//      it specifies the net name to use instead of the name the corresponding
//      net. If not found, the default net name specified in the assignment
//      definition is used.
//
//  oaTermConnectDef
//      This class implements a connectDef that associates an oaAssignmentDef
//      with a single-bit terminal. Applications traversing connectivity search
//      up the design hierarchy for an oaAssignment that has the lookup name
//      specified in the assignment definition. If an oaAssignment is found,
//      it specifies the net name to use to externally connect the corresponding
//      terminal to. If not found, the default net name specified in the
//      assignment definition is used.
//
// *****************************************************************************
// 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(oaConnectDef_P)
#define oaConnectDef_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaTerm.h"
#include "oaAssignmentDef.h"



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



// *****************************************************************************
// oaConnectDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaConnectDef : public oaBlockObject {
public:
    void                    destroy();

    void                    getAssignmentDef(oaAssignmentDef &assignmentDef) const;

    enum {dtIndex = oacConnectDefDataType};
};



// *****************************************************************************
// oaNetConnectDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaNetConnectDef : public oaConnectDef {
public:
    static oaNetConnectDef  *create(const oaBitNet          *net,
                                    const oaAssignmentDef   &assignmentDef);

    oaBitNet                *getNet() const;
};



// *****************************************************************************
// oaTermConnectDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaTermConnectDef : public oaConnectDef {
public:
    static oaTermConnectDef *create(const oaBitTerm         *term,
                                    const oaAssignmentDef   &assignmentDef);

    oaBitTerm               *getTerm() const;
};



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

template<>
class oaTraits<oaNetConnectDef> {
public:
    typedef oaConnectDefModTypeEnum modTypeType;
    typedef oaConnectDef            parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacConnectDefDataType};
    enum {dataTypeEnumVal = oacConnectDefDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacNetConnectDefType};
};

template<>
class oaTraits<oaTermConnectDef> {
public:
    typedef oaConnectDefModTypeEnum modTypeType;
    typedef oaConnectDef            parentType;
    enum {isMultiDomain = true};
    enum {dtIndex = oacConnectDefDataType};
    enum {dataTypeEnumVal = oacConnectDefDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacTermConnectDefType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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