oaOccBusNetDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccBusNetDef.h
//
// This file contains the definition for the oaOccBusNetDef class, which
// implements the definition of a busNet occurrence, including its name and
// bit-range. A busNetDef occurrence is never created by applications. Instead,
// it is automatically created whenever applications create busNets. Since
// multiple busNets can refer to different members of the same busNet
// definition, the busNetDef represents the super-set of all members of the
// busNets.
//
// Implicitly created logical busNet definitions are automatically destroyed
// when the last busNet with the same name is destroyed. Explicitly created
// logical busNet definitions must be explicitly destroyed. An exception will
// be thrown if an attempt is made to destroy an implicitly created logical
// busNet definition. An exception will also be thrown if an attempt is made to
// destroy an explicitly created logical busNet definition that still has
// logical busNets associated with it.
//
// *****************************************************************************
// 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(oaOccBusNetDef_P)
#define oaOccBusNetDef_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBusNetDef.h"
#include "oaOccurrence.h"



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



// *****************************************************************************
// oaOccBusNetDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccBusNetDef : public oaOccObject {
public:
    static oaOccBusNetDef                           *find(const oaOccurrence    *occurrence,
                                                          const oaScalarName    &name);

    oaUInt4                                         getMinIndex() const;
    oaUInt4                                         getMaxIndex() const;
    oaUInt4                                         getNumBits() const;

    void                                            getName(oaScalarName &name) const;
    void                                            getName(const oaNameSpace   &ns,
                                                            oaString            &name) const;
    void                                            getPathName(oaScalarName &pathName) const;
    void                                            getPathName(const oaNameSpace   &ns,
                                                                oaString            &pathName) const;

    oaBitOrder                                      getBitOrder() const;

    oaBoolean                                       isImplicit() const;

    oaCollection<oaOccBusNet, oaOccBusNetDef>       getBusNets() const;
    oaCollection<oaOccBusNetBit, oaOccBusNetDef>    getBusNetBits() const;

    enum {dtIndex = oacBusNetDefDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccBusNetDef> {
public:
    typedef oaOccObject             parentType;
    typedef oaBusNetDefModTypeEnum  modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacBusNetDefDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccBusNetDefType};
    enum {dataTypeEnumVal = oacBusNetDefDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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