oaModBusTermDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModBusTermDef.h
//
// This file contains the definition for the oaModBusTermDef class and its
// public supporting classes. The oaModBusTermDef class implements the
// definition of a busTerm in the module 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.
//
// A logical busTermDef is automatically created if necessary whenever
// applications create logical busTerms. These implicit logical busTerm
// definitions will have no bitOrder. Applications may explicitly create a
// logical busTerm definition in order to specify that it has a specific
// bitOrder.
//
// Implicitly created logical busTerm definitions are automatically destroyed
// when the last busTerm with the same name is destroyed. Explicitly created
// logical busTerm 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 busTerm definition that still has
// logical 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(oaModBusTermDef_P)
#define oaModBusTermDef_P



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



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



// *****************************************************************************
// oaModBusTermDef
// *****************************************************************************
class OA_DESIGN_DLL_API oaModBusTermDef : public oaModObject {
public:
    static oaModBusTermDef                          *create(const oaModule      *module,
                                                            const oaScalarName  &name,
                                                            oaBitOrder          order);

    static oaModBusTermDef                          *find(const oaModule        *module,
                                                          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<oaModBusTerm, oaModBusTermDef>     getBusTerms() const;
    oaCollection<oaModBusTermBit, oaModBusTermDef>  getBusTermBits() const;

    enum {dtIndex = oacBusTermDefDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModBusTermDef> {
public:
    typedef oaModObject             parentType;
    typedef oaBusTermDefModTypeEnum modTypeType;
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {dtIndex = oacBusTermDefDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModBusTermDefType};
    enum {dataTypeEnumVal = oacBusTermDefDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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