oaModConnectDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModConnectDef.h
//
// This file contains the definition of the oaModConnectDef class, its derived
// classes, and its public supporting classes. The oaModConnectDef class is an
// abstract base for all types of logical connection definitions. A connection
// definition specifies an oaAssignmentDef to be used for the associated
// connectivity object. The derived classes include:
//
//  oaModNetConnectDef
//      This class implements a connectDef that associates a single-bit,
//      explicit net occurrence with a given oaAssignmentDef. The connectDef is
//      interpreted by connectivity traversal applications where the
//      assignmentDef is used to determine the name to use for the associated
//      net.
//
//  oaModTermConnectDef
//      This class implements a connectDef that is associated with a single-bit,
//      explicit terminal occurrence with a given oaAssignmentDef. The
//      connectDef is interpreted by connectivity traversal applications where
//      the assignmentDef is used to determine the name of the net to externally
//      connect the terminal to.
//
// *****************************************************************************
// 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(oaModConnectDef_P)
#define oaModConnectDef_P



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



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



// *****************************************************************************
// oaModConnectDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaModConnectDef : public oaModObject {
public:
    void                    destroy();

    void                    getAssignmentDef(oaAssignmentDef &assignmentDef) const;

    enum {dtIndex = oacConnectDefDataType};
};



// *****************************************************************************
// oaModNetConnectDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaModNetConnectDef : public oaModConnectDef {
public:
    static oaModNetConnectDef   *create(const oaModBitNet       *net,
                                        const oaAssignmentDef   &assignmentDef);

    oaModBitNet                 *getNet() const;
};



// *****************************************************************************
// oaModTermConnectDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaModTermConnectDef : public oaModConnectDef {
public:
    static oaModTermConnectDef  *create(const oaModBitTerm      *term,
                                        const oaAssignmentDef   &assignmentDef);

    oaModBitTerm                *getTerm() const;
};



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

template<>
class oaTraits<oaModNetConnectDef> {
public:
    typedef oaConnectDefModTypeEnum modTypeType;
    typedef oaModConnectDef         parentType;
    enum {dtIndex = oacConnectDefDataType};
    enum {dataTypeEnumVal = oacConnectDefDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModNetConnectDefType};
};

template<>
class oaTraits<oaModTermConnectDef> {
public:
    typedef oaConnectDefModTypeEnum modTypeType;
    typedef oaModConnectDef         parentType;
    enum {dtIndex = oacConnectDefDataType};
    enum {dataTypeEnumVal = oacConnectDefDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModTermConnectDefType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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