oaModBusTermBit.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModBusTermBit.h
//
// This file contains the definition for the oaModBusTermBit class and its
// public supporting classes. The oaModBusTermBit class implements a single bit
// of a logical busTerm. BusTermBits are automatically created and destroyed as
// busTerms are created and destroyed. Editing is restricted on implicitly
// created busTermBits because they are automatically deleted when the last
// busTerm containing the bit is deleted.
//
// BusTermBits may be explicitly created as well. Explicitly created
// busTermBits may be modified like other terminal objects because they are not
// automatically deleted even if they represent a bit of a busTerm that is
// deleted.
//
// The implicit busTermBits of a busTerm may be made explicit when the busTerm
// undergoes "scalarization". The scalarization of a busTerm makes all
// associated busTermBits 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(oaModBusTermBit_P)
#define oaModBusTermBit_P



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



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



// *****************************************************************************
// oaModBusTermBit
// *****************************************************************************
class OA_DESIGN_DLL_API oaModBusTermBit : public oaModBitTerm {
public:
    static oaModBusTermBit  *create(oaModBitNet         *modNet,
                                    const oaScalarName  &baseName,
                                    oaUInt4             bitIndex,
                                    oaTermType          type = oacInputOutputTermType);
    static oaModBusTermBit  *create(oaModBitNet             *modNet,
                                    const oaVectorBitName   &bitName,
                                    oaTermType              type = oacInputOutputTermType);

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

    static oaBoolean        isValidName(const oaModBitNet   *net,
                                        const oaScalarName  &baseName,
                                        oaUInt4             bitIndex);

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

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

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



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaModBusTermBit> {
public:
    typedef oaTermModTypeEnum   modTypeType;
    typedef oaModBitTerm        parentType;
    enum {dtIndex = oacTermDataType};
    enum {dataTypeEnumVal = oacTermDataType};
    enum {domain = oacModDomain};
    enum {isMultiDomain = true};
    enum {dbType = oacDesignDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacModBusTermBitType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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