oaDevice.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDevice.h
//
// This file contains the definitions for the oaDevice and oaEndpointType
// classes. oaDevice is an abstract base for all devices in the parasitic graph
// for a net. For devices that have two endpoints, oaEndpointType is used to
// distinguish between the two.
//
// *****************************************************************************
// 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: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaDevice_P)
#define oaDevice_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaDesignModTypes.h"
#include "oaDesign.h"



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



// *****************************************************************************
// Constants
// *****************************************************************************
#define oacInvalidDeviceID  oacNullIndex



// *****************************************************************************
// oaEndpointEnum
// *****************************************************************************
#define oavNumEndpointTypes     2

enum oaEndpointTypeEnum {
    oacFromEndpointType = 0,
    oacToEndpointType   = 1
};



// *****************************************************************************
// oaEndpointType
// *****************************************************************************
class OA_DESIGN_DLL_API oaEndpointType {
public:
                            oaEndpointType(oaEndpointTypeEnum valueIn);
                            oaEndpointType(const oaString &name);
                            ~oaEndpointType();

    const oaString          &getName() const;

                            operator                oaEndpointTypeEnum() const;

private:
    oaEndpointTypeEnum      value;

    static const oaString   names[];
};



// *****************************************************************************
// oaDevice
// *****************************************************************************
class OA_DESIGN_DLL_API oaDevice : public oaDesignObject {
public:
    static oaDevice                         *find(const oaParasiticNetwork  *network,
                                                  oaUInt4                   id,
                                                  oaBoolean                 local);

    static oaDevice                         *find(const oaParasiticNetwork  *network,
                                                  const oaString            &name);

    static oaBoolean                        isValidName(const oaParasiticNetwork    *network,
                                                        const oaString              &name);

    static oaUInt4                          getUniqueId(oaParasiticNetwork *network);
    static oaUInt4                          getUniqueId(oaDesign *design);

    void                                    destroy();

    oaBoolean                               hasId() const;

    oaUInt4                                 getId() const;

    void                                    setName(const oaString &name);
    void                                    getName(oaString &name) const;

    oaParasiticNetwork                      *getParasiticNetwork() const;

    void                                    addToSubNetwork(oaSubNetwork *subNetwork);
    void                                    removeFromSubNetwork(oaSubNetwork *subNetwork);

    oaCollection<oaSubNetwork, oaDevice>    getSubNetworks() const;

    enum {dtIndex = oacDeviceDataType};
    enum {domain = oacNoDomain};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaDevice> {
public:
    typedef oaDesignObject      parentType;
    typedef oaDeviceModTypeEnum modTypeType;
    enum {dbType = oacDesignDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dtIndex = oacDeviceDataType};
    enum {dataTypeEnumVal = oacDeviceDataType};
    enum {abstractTypeEnumVal = oacDeviceType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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