oaHierPath Class Reference


Public Methods

 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

Detailed Description

The oaHierPath utility class implements functions for referring to a specific instance 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. Functions are implemented that allow applications to examine the contents of the path.

Constructor & Destructor Documentation

oaHierPath::oaHierPath (  oaUInt4    sizeIn = 10 )  [inline]
 

This function constructs an oaHierPath object, initializing the path so the path is empty.

Parameters:
sizeIn The size of this path; the default value is 10

oaHierPath::oaHierPath (  const oaHierPath &    pathIn ) 
 

This function constructs a new oaHierPath object by copying the specified oaHierPath object.

Parameters:
pathIn The oaHierPath object to copy

oaHierPath::~oaHierPath (    )  [inline]
 

This function destroys this oaHierPath object.

Member Function Documentation

oaUInt4 oaHierPath::getDepth (    )  const [inline]
 

This function returns the depth of this oaHierPath.

void oaHierPath::getLevel (  oaUInt4    level,
oaRef *&    ref,
oaUInt4 &    row,
oaUInt4 &    col
)  const [inline]
 

This function returns the specified level in this path.

Parameters:
level The specified level of interest
ref The reference to return
row The reference of the row
col The reference of the col

void oaHierPath::getTransform (  oaTransform &    result )  const
 

This function returns the concatenated transform for the context of this oaHierPath object.

Parameters:
result The reference of the transform to return

oaBoolean oaHierPath::operator!= (  const oaHierPath &    pathIn )  const [inline]
 

This function compares the specified oaHierPath object with this oaHierPath object. If the two oaHierPath objects are not the same, this function returns true. Otherwise, this function returns false.

Parameters:
pathIn The oaHierPath to compare

oaHierPath & oaHierPath::operator= (  const oaHierPath &    pathIn ) 
 

This function is the assignment operator that copies the specified oaHierPath object and returns it. The function copies all member data so the duplicate does not rely on information from the original.

oaBoolean oaHierPath::operator== (  const oaHierPath &    pathIn )  const [inline]
 

This function compares the specified oaHierPath object with this oaHierPath object. If the two oaHierPath objects are the same, this function returns true. Otherwise, this function returns false.

Parameters:
pathIn The oaHierPath object to compare

void oaHierPath::popLevel (    )  [inline]
 

This function pops the top level off of this oaHierPath.

void oaHierPath::pushLevel (  oaRef *    ref,
oaUInt4    row = 0,
oaUInt4    col = 0
) 
 

This function pushes a new level onto the top of this oaHierPath object. The oaHierPath object is resized if necessary.

Parameters:
ref The reference to push onto the top of this oaHierPath object
row The row index; the default value is zero
col The column index; the default value is zero

void oaHierPath::reset (    )  [inline]
 

This function resets this oaHierPath object to empty.

void oaHierPath::setLevel (  oaUInt4    level,
oaRef *    ref,
oaUInt4    row,
oaUInt4    col
)  [inline]
 

This function sets the element of the specified level. The depth of this hierPath is incremented. It is assumed that the element array has been allocated properly.

Parameters:
level The specified level of interest
ref The reference
row The row number
col The column number

void oaHierPath::setSize (  oaUInt4    sizeIn )  [inline]
 

This function sets the size of this hierPath to the specified size and resets the depth to zero. If the given size is greater than the exiting size, this function allocates new storage and removes the existing data.

Parameters:
sizeIn The new size

The documentation for this class was generated from the following files:

Return to top of page




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