oaHierPath.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaHierPath.h
//
// This file contains the definitions for the oaHierPath and oaHierPathElement
// classes. These utility classes implement methods for referring to a specific
// reference of a design hierarchy. A hierarchical path is composed of an array
// that contains the elements of the path and the depth of the path. Methods are
// implemented that allow applications to examine the contents of the path.
//
// *****************************************************************************
// 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(oaHierPath_P)
#define oaHierPath_P



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



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



// *****************************************************************************
// oaHierPathElement
// *****************************************************************************
class OA_DESIGN_DLL_API oaHierPathElement {
    oaRef                   *ref;
    oaUInt4                 row;
    oaUInt4                 col;

    friend class oaHierPath;
};



// *****************************************************************************
// oaHierPath
// *****************************************************************************
class OA_DESIGN_DLL_API oaHierPath {
public:
                            oaHierPath(oaUInt4 sizeIn = 10);
                            oaHierPath(const oaHierPath &pathIn);
                            ~oaHierPath();

    oaHierPath              &operator=(const oaHierPath &pathIn);
    oaBoolean               operator==(const oaHierPath &pathIn) const;
    oaBoolean               operator!=(const oaHierPath &pathIn) const;

    void                    pushLevel(oaRef     *ref,
                                      oaUInt4   row = 0,
                                      oaUInt4   col = 0);
    void                    popLevel();

    void                    setSize(oaUInt4 sizeIn);
    void                    setLevel(oaUInt4    level,
                                     oaRef      *ref,
                                     oaUInt4    row,
                                     oaUInt4    col);

    void                    reset();

    oaUInt4                 getDepth() const;
    void                    getLevel(oaUInt4    index,
                                     oaRef      *&ref,
                                     oaUInt4    &row,
                                     oaUInt4    &col) const;

    void                    getTransform(oaTransform &result) const;

private:
    oaHierPathElement       *array;
    oaUInt4                 depth;
    oaUInt4                 size;
};



END_OA_NAMESPACE

#endif

Return to top of page

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