oaModBusTerm.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaModBusTerm.h
//
// This file contains the definition for the oaModBusTerm class and its public
// supporting classes. The oaModBusTerm class implements a vector terminal in
// the module domain.
//
// *****************************************************************************
// 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(oaModBusTerm_P)
#define oaModBusTerm_P



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



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



// *****************************************************************************
// oaModBusTerm
// *****************************************************************************
class OA_DESIGN_DLL_API oaModBusTerm : public oaModTerm {
public:
    static oaModBusTerm     *create(oaModNet            *modNet,
                                    const oaScalarName  &name,
                                    oaUInt4             start,
                                    oaUInt4             stop,
                                    oaUInt4             step,
                                    oaTermType          termType = oacInputOutputTermType);

    static oaModBusTerm     *create(oaModNet            *modNet,
                                    const oaVectorName  &name,
                                    oaTermType          termType = oacInputOutputTermType);

    static oaModBusTerm     *create(oaModNet                *modNet,
                                    const oaVectorBitName   &name,
                                    oaTermType              termType = oacInputOutputTermType);
                                
    static oaModBusTerm     *find(const oaModule        *module,
                                  const oaScalarName    &name,
                                  oaUInt4               start,
                                  oaUInt4               stop,
                                  oaUInt4               step);
    static oaBoolean        isValidName(const oaModule      *module,
                                        const oaModNet      *net,
                                        const oaScalarName  &name,
                                        oaUInt4             start,
                                        oaUInt4             stop,
                                        oaUInt4             step);

    oaModBusTermDef         *getDef() const;
    oaUInt4                 getStart() const;
    oaUInt4                 getStop() const;
    oaUInt4                 getStep() const;

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

    void                    setBaseName(const oaScalarName &name);
    void                    setRange(oaUInt4    start,
                                     oaUInt4    stop);
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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