oaOccBusTermDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaOccBusTermDef.h
//
// This file contains the definition for the oaOccBusTermDef class, which
// implements the definition of a busTerm in the occurrence domain, including
// its name and bit-range. Since multiple busTerms can refer to different members of the same busTerm
// definition, the busTermDef represents the super-set of all members of the
// busTerms.
//
// Implicitly created occurrence busTerm definitions are automatically destroyed
// when the last busTerm with the same name is destroyed. Explicitly created
// occurrence busTerm definitions must be explicitly destroyed. An exception will
// be thrown if an attempt is made to destroy an implicitly created occurrence
// busTerm definition. An exception will also be thrown if an attempt is made to
// destroy an explicitly created occurrence busTerm definition that still has
// occurrence busTerms 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(oaOccBusTermDef_P)
#define oaOccBusTermDef_P



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



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



// *****************************************************************************
// oaOccBusTermDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaOccBusTermDef : public oaOccObject {
public:
    static oaOccBusTermDef                          *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;
    oaBitOrder                                      getBitOrder() const;

    oaBoolean                                       isImplicit() const;

    oaCollection<oaOccBusTerm, oaOccBusTermDef>     getBusTerms() const;
    oaCollection<oaOccBusTermBit, oaOccBusTermDef>  getBusTermBits() const;

    oaCollection<oaOccBusTerm, oaOccBusTermDef>     getBusTerms(oaUInt4 filterFlags) const;
    oaCollection<oaOccBusTermBit, oaOccBusTermDef>  getBusTermBits(oaUInt4 filterFlags) const;

    enum {dtIndex = oacBusTermDefDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaOccBusTermDef> {
public:
    typedef oaOccObject             parentType;
    typedef oaBusTermDefModTypeEnum modTypeType;
    enum {domain = oacOccDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacBusTermDefDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacOccBusTermDefType};
    enum {dataTypeEnumVal = oacBusTermDefDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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