oaBusNetDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaBusNetDef.h
//
// This file contains the definition for the oaBusNetDef class and its public
// supporting classes. The oaBusNetDef class implements the definition of a
// busNet, including its name and bit-range. 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.
//
// A busNetDef is automatically created if necessary whenever applications
// create busNets. These implicit busNet definitions will have no bitOrder.
// Applications may explicitly create a busNet definition in order to specify
// that it has a specific bitOrder.
//
// Implicitly created busNet definitions are automatically destroyed when the
// last busNet with the same name is destroyed. Explicitly created busNet
// definitions must be explicitly destroyed. An exception will be thrown if an
// attempt is made to destroy an implicitly created busNet definition. An
// exception will also be thrown if an attempt is made to destroy an explicitly
// created busNet definition that still has busNets associated with it.
//
// The public supporting classes include:
//
//  oaBitOrder
//      The oaBitOrder class implements an enumerated type that specifies
//      the bitOrder for a busNet definition. Its possible values are "none",
//      "ascending", and "descending".
//
// *****************************************************************************
// 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(oaBusNetDef_P)
#define oaBusNetDef_P



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



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



// *****************************************************************************
// oaBitOrderEnum
// *****************************************************************************
#define oavNumBitOrders     3

enum oaBitOrderEnum {
    oacNoneBitOrder         = 0,
    oacAscendingBitOrder    = 1,
    oacDescendingBitOrder   = 2
};



// *****************************************************************************
// oaBitOrder
// *****************************************************************************
class OA_DESIGN_DLL_API oaBitOrder {
public:
                            oaBitOrder(oaBitOrderEnum valueIn);
                            oaBitOrder(const oaString &name);

    const oaString          &getName() const;

                            operator                oaBitOrderEnum() const;

private:
    oaBitOrderEnum          value;

    static const oaString   names[];
};



// *****************************************************************************
// oaBusNetDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaBusNetDef : public oaBlockObject {
public:
    static oaBusNetDef                          *create(const oaBlock       *block,
                                                        const oaScalarName  &name,
                                                        oaBitOrder          order);

    static oaBusNetDef                          *find(const oaBlock         *block,
                                                      const oaScalarName    &name);

    void                                        destroy();

    oaUInt4                                     getMinIndex() const;
    oaUInt4                                     getMaxIndex() const;
    oaUInt4                                     getNumBits() const;
    void                                        getName(oaScalarName &name) const;
    void                                        getName(const oaNameSpace   &ns,
                                                        oaString            &name) const;
    oaBitOrder                                  getBitOrder() const;

    oaBoolean                                   isImplicit() const;

    void                                        setBitOrder(oaBitOrder order);

    oaCollection<oaBusNet, oaBusNetDef>         getBusNets() const;
    oaCollection<oaBusNetBit, oaBusNetDef>      getBusNetBits() const;

    oaCollection<oaOccBusNet, oaBusNetDef>      getOccBusNets() const;
    oaCollection<oaOccBusNetBit, oaBusNetDef>   getOccBusNetBits() const;

    enum {dtIndex = oacBusNetDefDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaBusNetDef> {
public:
    typedef oaBlockObject           parentType;
    typedef oaBusNetDefModTypeEnum  modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = true};
    enum {dtIndex = oacBusNetDefDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacBusNetDefType};
    enum {dataTypeEnumVal = oacBusNetDefDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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