oaScanChain.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaScanChain.h
//
// This file contains the definition for the oaScanChain class. This class
// implements one scan chain.
//
// *****************************************************************************
// 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaScanChain_P)
#define oaScanChain_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBlock.h"
#include "oaScanChainSet.h"



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



// *****************************************************************************
// oaScanChain
// *****************************************************************************
class OA_DESIGN_DLL_API oaScanChain : public oaBlockObject {
public:
    static oaScanChain                          *create(oaBlock         *block,
                                                        const oaString  &name,
                                                        oaBlockObject   *startObject = NULL,
                                                        oaBlockObject   *stopObject     = NULL,
                                                        oaString        *partitionName = NULL,
                                                        oaUInt4         maxBits = 0);

    void                                        destroy();

    static oaScanChain                          *find(const oaBlock     *block,
                                                      const oaString    &name);

    void                                        getName(oaString &name) const;
    void                                        getPartitionName(oaString &name) const;
    oaUInt4                                     getMaxBits() const;
    oaDesignObject                              *getStartObject() const;
    oaDesignObject                              *getStopObject() const;

    void                                        setName(const oaString &name);
    void                                        setPartitionName(const oaString &name);
    void                                        setStartObject(oaDesignObject *object);
    void                                        setStopObject(oaDesignObject *object);
    void                                        setMaxBits(oaUInt4 maxBits);

    oaCollection<oaScanChainSet, oaScanChain>   getScanChainSets(oaUInt4 flag = oacOrderedScanChainSetType) const;

    enum {dtIndex = oacScanChainDataType};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaScanChain> {
public:
    typedef oaBlockObject           parentType;
    typedef oaScanChainModTypeEnum  modTypeType;
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {dtIndex = oacScanChainDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacScanChainType};
    enum {dataTypeEnumVal = oacScanChainDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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