oaNetTermArray.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaNetTermArray.h
//
// This file contains the definition for the oaNetTermArray class. This
// class implements a specification of all the connections between a set of
// nets and a set of terminals in an instance master. It is used with the 
// oaInstTerm::create() and oaModInstTerm::create() APIs.
//
// IMPORTANT! The public interface types cannot use the class based typedef
// because this will not work with the oaTcl auto-generation compiler.
//
// *****************************************************************************
// 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(oaNetTermArray_P)
#define oaNetTermArray_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaArray.h"
#include "oaNet.h"
#include "oaNetTermPair.h"



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



// *****************************************************************************
// oaNetTermArrayBase
// *****************************************************************************
template<class NetType, class TermType>
class oaNetTermArrayBase {
public:
    typedef oaNetTermPair<NetType, TermType>    NetTermPair;

                                                oaNetTermArrayBase(oaUInt4 size);

    void                                        append(const NetType    &net,
                                                       const TermType   &term);

    oaUInt4                                     getNumElements() const;
    void                                        setNumElements(oaUInt4 numElements);
    oaUInt4                                     getSize() const;

    const oaNetTermPair<NetType, TermType>      &get(oaUInt4 index) const;
    oaNetTermPair<NetType, TermType>            &get(oaUInt4 index);

    const oaNetTermPair<NetType, TermType>      &operator[](oaUInt4 index) const;
    oaNetTermPair<NetType, TermType>            &operator[](oaUInt4 index);

    oaUInt4                                     getNumBits() const;
    oaUInt4                                     getNumMultiBit() const;

private:
    oaArray<NetTermPair>                        elements;
};



// *****************************************************************************
// oaNetTermArray
// *****************************************************************************
class oaNetTermArray : public oaNetTermArrayBase<oaNet*, oaTerm*> {
public:
                            oaNetTermArray(oaUInt4 size = 4);
};

class oaNetTermNameArray : public oaNetTermArrayBase<oaNet*, oaName> {
public:
                            oaNetTermNameArray(oaUInt4 size = 4);
};

class oaNetTermPosArray : public oaNetTermArrayBase<oaNet*, oaUInt4> {
public:
                            oaNetTermPosArray(oaUInt4 size = 4);
};



// *****************************************************************************
// oaModNetTermArray
// *****************************************************************************
class oaModNetTermArray : public oaNetTermArrayBase<oaModNet*, oaModTerm*> {
public:
                            oaModNetTermArray(oaUInt4 size = 4);
};

class oaModNetTermNameArray : public oaNetTermArrayBase<oaModNet*, oaName> {
public:
                            oaModNetTermNameArray(oaUInt4 size = 4);
};

class oaModNetTermPosArray : public oaNetTermArrayBase<oaModNet*, oaUInt4> {
public:
                            oaModNetTermPosArray(oaUInt4 size = 4);
};



END_OA_NAMESPACE

#endif

Return to top of page

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