oaNode.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaNode.h
//
// This file contains the definitions for the oaNode class, which represents
// a node in a parasitic network for a net.
//
// *****************************************************************************
// 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(oaNode_P)
#define oaNode_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPoint.h"
#include "oaCollection.h"
#include "oaTechDBTypes.h"
#include "oaDesignModTypes.h"
#include "oaDesignObject.h"



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



// *****************************************************************************
// Constants
// *****************************************************************************
#define oacInvalidNodeID  oacNullIndex



// *****************************************************************************
// oaNode
// *****************************************************************************
class OA_DESIGN_DLL_API oaNode : public oaDesignObject {
public:
    static oaNode                           *create(oaParasiticNetwork *network);
    static oaNode                           *create(oaParasiticNetwork  *network,
                                                    oaUInt4             id);

    static oaNode                           *find(const oaParasiticNetwork  *network,
                                                  oaUInt4                   id);

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

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

    static oaUInt4                          getUniqueId(oaParasiticNetwork *network);

    void                                    destroy();

    void                                    setName(const oaString &name);
    void                                    setLayerNum(oaLayerNum layer);
    void                                    setLocation(const oaPoint &location);

    oaBoolean                               hasId() const;
    oaBoolean                               hasLayerNum() const;
    oaBoolean                               hasLocation() const;

    oaParasiticNetwork                      *getParasiticNetwork() const;
    oaUInt4                                 getId() const;
    void                                    getName(oaString &name) const;
    oaLayerNum                              getLayerNum() const;
    void                                    getLocation(oaPoint &location) const;

    void                                    addConn(oaDesignObject *conn);
    void                                    removeConn(oaDesignObject *conn);

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

    oaCollection<oaDevice, oaNode>          getFromDevices() const;
    oaCollection<oaDevice, oaNode>          getToDevices() const;
    oaCollection<oaSubNetwork, oaNode>      getSubNetworks() const;
    oaCollection<oaDesignObject, oaNode>    getConns() const;

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



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaNode> {
public:
    typedef oaDesignObject      parentType;
    typedef oaNodeModTypeEnum   modTypeType;
    enum {dbType = oacDesignDBType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dtIndex = oacNodeDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacNodeType};
    enum {dataTypeEnumVal = oacNodeDataType};
    enum {abstractTypeEnumVal = oacAbstractNodeType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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