oaModBusNetBit.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModBusNetBit.h
//
// This file contains the definition for the oaModBusNetBit class and its public
// supporting classes. The oaModBusNetBit class implements a single bit of a
// logical busNet. BusNetBits are automatically created and destroyed as
// busNets are created and destroyed. Editing is restricted on implicitly
// created busNetBits because they are automatically deleted when the last
// busNet containing the bit is deleted.
//
// BusNetBits may be explicitly created as well. Explicitly created busNetBits
// may be modified like any other net object because they are not automatically
// deleted even if they represent a bit of a busNet that is deleted.
//
// The implicit busNetBits of a busNet may be made explicit when the busNet
// undergoes "scalarization". The scalarization of a busNet makes all
// associated busNetBits explicit, that is, as if they had been created
// explicitly.
//
// *****************************************************************************
// 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(oaModBusNetBit_P)
#define oaModBusNetBit_P



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



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



// *****************************************************************************
// oaModBusNetBit
// *****************************************************************************
class OA_DESIGN_DLL_API oaModBusNetBit : public oaModBitNet {
public:
    static oaModBusNetBit   *create(oaModule            *module,
                                    const oaScalarName  &baseName,
                                    oaUInt4             bitIndex,
                                    oaSigType           type = oacSignalSigType,
                                    oaBoolean           isGlobal = false);
    static oaModBusNetBit   *create(oaModule                *module,
                                    const oaVectorBitName   &bitName,
                                    oaSigType               type = oacSignalSigType,
                                    oaBoolean               isGlobal = false);

    static oaModBusNetBit   *find(const oaModule        *module,
                                  const oaScalarName    &baseName,
                                  oaUInt4               bitIndex);

    static oaBoolean        isValidName(const oaModule      *module,
                                        const oaScalarName  &baseName,
                                        oaUInt4             bitIndex);

    oaModBusNetDef          *getDef() const;
    oaUInt4                 getBitIndex() const;

    using                   oaModNet::getName;
    void                    getName(oaVectorBitName &name) const;

    void                    setName(const oaScalarName  &baseName,
                                    oaUInt4             bitIndex);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModBusNetBit> {
public:
    typedef oaNetModTypeEnum    modTypeType;
    typedef oaModBitNet         parentType;
    enum {dtIndex = oacNetDataType};
    enum {dataTypeEnumVal = oacNetDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModBusNetBitType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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