riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

* ./hurricane/doc/hurricane : 

- Added (empty) directories "html" & "latex". Those directories are
       created by doxygen, but as they are used in the CMakeList.txt, they
       must be present even before the fisrt run of cmake (otherwise cmake
       choke on them).
   - Doxygen sets to only generate html & pdf (through LaTeX) documentation.
   - All ".dox" files corrected to suit the new function members naming
       scheme (some work may remains in code examples).
This commit is contained in:
Jean-Paul Chaput 2008-05-26 15:15:59 +00:00
parent 9370421039
commit 4fb6f4c886
38 changed files with 665 additions and 628 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
hurricane/doc/hurricane/BasicLayer.dox
View File

@ -19,8 +19,8 @@
*/ */
// \{ // \{
/*! \function BasicLayer* BasicLayer::Create(Technology* technology,const Name& name,const BasicLayer::Type& type,unsigned extractNumber,const Unit& minimalSize = 0,const Unit& minimalSpacing = 0); /*! \function BasicLayer* BasicLayer::create(Technology* technology,const Name& name,const BasicLayer::Type& type,unsigned extractNumber,const Unit& minimalSize = 0,const Unit& minimalSpacing = 0);
* Creates and returns a new basic layer named \c \<name\>, of * creates and returns a new basic layer named \c \<name\>, of
* type \c \<type\> for the given technology (some geometrical * type \c \<type\> for the given technology (some geometrical
* characteristics can also be specified). * characteristics can also be specified).
* *
@ -45,27 +45,15 @@
*/ */
// \{ // \{
/*! \function const BasicLayer::Type& BasicLayer::GetType() const; /*! \function const BasicLayer::Type& BasicLayer::getType() const;
* \Return the basic layer type. * \Return the basic layer type.
*/ */
/*! \function unsigned BasicLayer::GetExtractNumber() const; /*! \function unsigned BasicLayer::getExtractNumber() const;
* \Return the extract number. * \Return the extract number.
*/ */
/*! \function const unsigned short& BasicLayer::GetRedValue() const; /* \function const string& BasicLayer::getFillPattern() const;
* No description.
*/
/*! \function const unsigned short& BasicLayer::GetGreenValue() const;
* No description.
*/
/*! \function const unsigned short& BasicLayer::GetBlueValue() const;
* No description.
*/
/*! \function const string& BasicLayer::GetFillPattern() const;
* Basic layers have graphic display characteristics which are * Basic layers have graphic display characteristics which are
* defined by both a color and a filling pattern. The above * defined by both a color and a filling pattern. The above
* methods provide the corresponding accessor functions. * methods provide the corresponding accessor functions.
@ -89,7 +77,7 @@
* value). * value).
*/ */
/*! \function double BasicLayer::GetDisplayThreshold() const; /* \function double BasicLayer::getDisplayThreshold() const;
* In order to get an efficient graphic display we need : * In order to get an efficient graphic display we need :
* *
* On one hand, when we are in close view, quickly filter * On one hand, when we are in close view, quickly filter
@ -119,18 +107,18 @@
*/ */
// \{ // \{
/*! \function void BasicLayer::SetColor(unsigned short redValue, unsigned short greenValue, unsigned short blueValue); /* \function void BasicLayer::SetColor(unsigned short redValue, unsigned short greenValue, unsigned short blueValue);
* Sets the color of a basic layer. * Sets the color of a basic layer.
*/ */
/*! \function void BasicLayer::SetFillPattern(const string& fillPattern); /* \function void BasicLayer::SetFillPattern(const string& fillPattern);
* Sets the filling pattern of a basic layer. * Sets the filling pattern of a basic layer.
* *
* \caution Throws an exception if the string does't obey to the rules * \caution Throws an exception if the string does't obey to the rules
* described above. * described above.
*/ */
/*! \function void BasicLayer::SetDisplayThreshold(double threshold); /* \function void BasicLayer::SetDisplayThreshold(double threshold);
* Sets the display threshold of a basic layer. * Sets the display threshold of a basic layer.
*/ */

64
hurricane/doc/hurricane/Box.dox
View File

@ -27,7 +27,7 @@
Box box1(0, 0, 100, 100); Box box1(0, 0, 100, 100);
Box box2(20, 20, 50, 150; Box box2(20, 20, 50, 150;
if (box1.Inflate(3).Merge(box2.Translate(10, 10).Inflate(-1, 1)).Contains(20, 20)) { if (box1.inflate(3).merge(box2.translate(10, 10).inflate(-1, 1)).contains(20, 20)) {
// do we reach here ? that is the question ! // do we reach here ? that is the question !
} }
\endcode \endcode
@ -93,58 +93,58 @@ if (box1.Inflate(3).Merge(box2.Translate(10, 10).Inflate(-1, 1)).Contains(20, 20
*/ */
// \{ // \{
/*! \function const Unit& Box::GetXMin() const; /*! \function const Unit& Box::getXMin() const;
* \Return the XMin value : meaningful only for a non empty box. * \Return the XMin value : meaningful only for a non empty box.
*/ */
/*! \function const Unit& Box::GetYMin() const; /*! \function const Unit& Box::getYMin() const;
* \Return the YMin value : meaningful only for a non empty box. * \Return the YMin value : meaningful only for a non empty box.
*/ */
/*! \function const Unit& Box::GetXMax() const; /*! \function const Unit& Box::getXMax() const;
* \Return the XMax value : meaningful only for a non empty box. * \Return the XMax value : meaningful only for a non empty box.
*/ */
/*! \function const Unit& Box::GetYMax() const; /*! \function const Unit& Box::getYMax() const;
* \Return the YMax value : meaningful only for a non empty box. * \Return the YMax value : meaningful only for a non empty box.
*/ */
/*! \function Unit Box::GetXCenter() const; /*! \function Unit Box::getXCenter() const;
* \Return the abscissa of the box center : meaningful only for a non * \Return the abscissa of the box center : meaningful only for a non
* empty box. * empty box.
*/ */
/*! \function Unit Box::GetYCenter() const; /*! \function Unit Box::getYCenter() const;
* \Return the ordinate of the box center : meaningful only for a non * \Return the ordinate of the box center : meaningful only for a non
* empty box. * empty box.
*/ */
/*! \function Point Box::GetCenter() const; /*! \function Point Box::getCenter() const;
* \Return the box center point : meaningful only for a non empty box. * \Return the box center point : meaningful only for a non empty box.
*/ */
/*! \function Unit Box::GetWidth() const; /*! \function Unit Box::getWidth() const;
* \Return the box width : meaningful only for a non empty box. * \Return the box width : meaningful only for a non empty box.
*/ */
/*! \function Unit Box::GetHalfWidth() const; /*! \function Unit Box::getHalfWidth() const;
* \Return the half box width : meaningful only for a non empty box. * \Return the half box width : meaningful only for a non empty box.
*/ */
/*! \function Unit Box::GetHeight() const; /*! \function Unit Box::getHeight() const;
* \Return the box height : meaningful only for a non empty box. * \Return the box height : meaningful only for a non empty box.
*/ */
/*! \function Unit Box::GetHalfHeight() const; /*! \function Unit Box::getHalfHeight() const;
* \Return the half box height : meaningful only for a non empty box. * \Return the half box height : meaningful only for a non empty box.
*/ */
/*! \function Box Box::GetUnion(const Box& box) const; /*! \function Box Box::getUnion(const Box& box) const;
* \Return the smallest enclosing box containing the boxes \c \<this\> * \Return the smallest enclosing box containing the boxes \c \<this\>
* and \c \<box\>. The returned box may be empty if both are. * and \c \<box\>. The returned box may be empty if both are.
*/ */
/*! \function Box Box::GetIntersection(const Box& box) const; /*! \function Box Box::getIntersection(const Box& box) const;
* \Return box representing the overlapping area. This box is empty if * \Return box representing the overlapping area. This box is empty if
* either one of the two boxes is empty or if they are disjoint. * either one of the two boxes is empty or if they are disjoint.
*/ */
@ -156,41 +156,41 @@ if (box1.Inflate(3).Merge(box2.Translate(10, 10).Inflate(-1, 1)).Contains(20, 20
*/ */
// \{ // \{
/*! \function bool Box::IsEmpty() const; /*! \function bool Box::isEmpty() const;
* \Return \true if the box is empty, else \false. * \Return \true if the box is empty, else \false.
*/ */
/*! \function bool Box::IsFlat() const; /*! \function bool Box::isFlat() const;
* \Return \true if the box is non void and if we have either * \Return \true if the box is non void and if we have either
* ((XMin==XMax) an (YMin\<YMax)) or ((XMin\<XMax) and * ((XMin==XMax) an (YMin\<YMax)) or ((XMin\<XMax) and
* (YMin==YMax)). * (YMin==YMax)).
*/ */
/*! \function bool Box::IsPonctual() const; /*! \function bool Box::isPonctual() const;
* \Return \true if the box is reduced to a point, else \false. * \Return \true if the box is reduced to a point, else \false.
*/ */
/*! \function bool Box::Contains(const Unit& x, const Unit& y) const; /*! \function bool Box::contains(const Unit& x, const Unit& y) const;
* \Return \true if the box is non empty and contains the point defined * \Return \true if the box is non empty and contains the point defined
* by the coordinates \c \<x\>, \c \<y\> else \false. * by the coordinates \c \<x\>, \c \<y\> else \false.
*/ */
/*! \function bool Box::Contains(const Point& point) const; /*! \function bool Box::contains(const Point& point) const;
* \Return \true if the box is non empty and contains the point * \Return \true if the box is non empty and contains the point
* \c \<point\>, else \false. * \c \<point\>, else \false.
*/ */
/*! \function bool Box::Contains(const Box& box) const; /*! \function bool Box::contains(const Box& box) const;
* \Return \true if the two boxes are non empty and if the box * \Return \true if the two boxes are non empty and if the box
* \c \<this\> contains the box \c \<box\>, else \false. * \c \<this\> contains the box \c \<box\>, else \false.
*/ */
/*! \function bool Box::Intersect(const Box& box) const; /*! \function bool Box::intersect(const Box& box) const;
* \Return \true if the two boxes are non empty and if they overlap, * \Return \true if the two boxes are non empty and if they overlap,
* else \false. * else \false.
*/ */
/*! \function bool Box::IsConstrainedBy(const Box& box) const; /*! \function bool Box::isConstrainedBy(const Box& box) const;
* \Return \true if the two boxes are non empty, if the box \c \<this\> * \Return \true if the two boxes are non empty, if the box \c \<this\>
* contains the box \c \<box\> and if those two boxes have at * contains the box \c \<box\> and if those two boxes have at
* least a common border side, else \false. * least a common border side, else \false.
@ -203,24 +203,24 @@ if (box1.Inflate(3).Merge(box2.Translate(10, 10).Inflate(-1, 1)).Contains(20, 20
*/ */
// \{ // \{
/*! \function Box& Box::MakeEmpty(); /*! \function Box& Box::makeEmpty();
* Transforms the box into an empty one. * Transforms the box into an empty one.
*/ */
/*! \function Box& Box::Inflate(const Unit& d); /*! \function Box& Box::inflate(const Unit& d);
* Expands (or contracts) the box, if not empty, in each * Expands (or contracts) the box, if not empty, in each
* direction of the quantity \c \<d\>. This quantity might be * direction of the quantity \c \<d\>. This quantity might be
* negative enough to transform it into an empty box. * negative enough to transform it into an empty box.
*/ */
/*! \function Box& Box::Inflate(const Unit& dx, const Unit& dy); /*! \function Box& Box::inflate(const Unit& dx, const Unit& dy);
* Expands (or contracts) the box, if not empty, horizontaly of * Expands (or contracts) the box, if not empty, horizontaly of
* the quantity \c \<dx\> and vertically of the quatity * the quantity \c \<dx\> and vertically of the quatity
* \c \<dy\>. Those quantities might be negative enough to * \c \<dy\>. Those quantities might be negative enough to
* transform it into an empty box. * transform it into an empty box.
*/ */
/*! \function Box& Box::Inflate(const Unit& dxMin, const Unit& dyMin, const Unit& dxMax, const Unit& dyMax); /*! \function Box& Box::inflate(const Unit& dxMin, const Unit& dyMin, const Unit& dxMax, const Unit& dyMax);
* Expands (or contracts) the box, if not empty, on the left of * Expands (or contracts) the box, if not empty, on the left of
* the quantity \c \<dxMin\>, on the bottom of the quantity * the quantity \c \<dxMin\>, on the bottom of the quantity
* \c \<dyMin\>, on the right of the quantity \c \<dxMax\> and * \c \<dyMin\>, on the right of the quantity \c \<dxMax\> and
@ -228,31 +228,31 @@ if (box1.Inflate(3).Merge(box2.Translate(10, 10).Inflate(-1, 1)).Contains(20, 20
* might be negative enough to transform it into an empty box. * might be negative enough to transform it into an empty box.
*/ */
/*! \function Box& Box::Merge(const Unit& x, const Unit& y); /*! \function Box& Box::merge(const Unit& x, const Unit& y);
* Expands the box in order that it encloses the point defined * Expands the box in order that it encloses the point defined
* by coordinates \c \<x\> and \c \<y\>. If the box was * by coordinates \c \<x\> and \c \<y\>. If the box was
* initially empty it becomes reduced to the enclosed point. * initially empty it becomes reduced to the enclosed point.
*/ */
/*! \function Box& Box::Merge(const Point& point); /*! \function Box& Box::merge(const Point& point);
* Expands the box in order that it encloses the point * Expands the box in order that it encloses the point
* \c \<point\>. If the box was initially empty it becomes * \c \<point\>. If the box was initially empty it becomes
* reduced to the enclosed point. * reduced to the enclosed point.
*/ */
/*! \function Box& Box::Merge(const Unit& x1, const Unit& y1, const Unit& x2, const Unit& y2); /*! \function Box& Box::merge(const Unit& x1, const Unit& y1, const Unit& x2, const Unit& y2);
* Expands the box in order that it encloses the points defined * Expands the box in order that it encloses the points defined
* by coordinates \c \<x1\>, \c \<y1\> and \c \<x2\>, \c \<y2\>. * by coordinates \c \<x1\>, \c \<y1\> and \c \<x2\>, \c \<y2\>.
*/ */
/*! \function Box& Box::Merge(const Box& box); /*! \function Box& Box::merge(const Box& box);
* Expands the box in order that it encloses, if not empty, the * Expands the box in order that it encloses, if not empty, the
* box \c \<box\>. If the box \c \<this\> was initially empty it * box \c \<box\>. If the box \c \<this\> was initially empty it
* becomes reduced to the enclosed box. * becomes reduced to the enclosed box.
*/ */
/*! \function Box& Box::Translate(const Unit& dx, const Unit& dy); /*! \function Box& Box::translate(const Unit& dx, const Unit& dy);
* Translates the box, if not empty, of the quantities \c \<dx\> * translates the box, if not empty, of the quantities \c \<dx\>
* and \c \<dy\>. * and \c \<dy\>.
*/ */

20
hurricane/doc/hurricane/CMakeLists.txt
View File

@ -1,8 +1,12 @@
#
# set ( htmlInstallDir /share/doc/en/html/hurricane ) set ( htmlInstallDir /share/doc/en/html/hurricane )
# set ( latexInstallDir /share/doc/en/latex/hurricane )
# add_custom_target ( doc ALL cd ${HURRICANE_SOURCE_DIR}/doc/hurricane && ${DOXYGEN_EXECUTABLE} doxyfile )
# add_custom_target ( doc ALL cd ${HURRICANE_SOURCE_DIR}/doc/hurricane && ${DOXYGEN_EXECUTABLE} doxyfile )
# install ( DIRECTORY html DESTINATION ${htmlInstallDir} )
# install ( FILES customHierarchy.html DESTINATION ${htmlInstallDir}/html ) install ( DIRECTORY html/ DESTINATION ${htmlInstallDir} )
# install ( FILES customSummary.html DESTINATION ${htmlInstallDir}/html ) install ( FILES customHierarchy.html DESTINATION ${htmlInstallDir} )
install ( FILES customSummary.html DESTINATION ${htmlInstallDir} )
install ( DIRECTORY latex/ DESTINATION ${latexInstallDir} )
install ( FILES asimbook.cls DESTINATION ${latexInstallDir} )

78
hurricane/doc/hurricane/Cell.dox
View File

@ -13,8 +13,8 @@
*/ */
// \{ // \{
/*! \function Cell* Cell::Create ( Library* library, const Name& name ); /*! \function Cell* Cell::create ( Library* library, const Name& name );
* Creates and returns a new Cell named \e name for the Library * creates and returns a new Cell named \e name for the Library
* \e library. * \e library.
* *
* \caution Throws an exception if the Library is null, if the Name is * \caution Throws an exception if the Library is null, if the Name is
@ -29,76 +29,76 @@
*/ */
// \{ // \{
/*! \function Library* Cell::GetLibrary () const; /*! \function Library* Cell::getLibrary () const;
* Returns the Library owning the Cell. * Returns the Library owning the Cell.
*/ */
/*! \function const Name& Cell::GetName () const; /*! \function const Name& Cell::getName () const;
* Returns the Name of the Cell. * Returns the Name of the Cell.
*/ */
/*! \function Instance* Cell::GetInstance ( const Name& name ) const; /*! \function Instance* Cell::getInstance ( const Name& name ) const;
* Returns the Instance of name \e name if it exists, else \NULL. * Returns the Instance of name \e name if it exists, else \NULL.
*/ */
/*! \function Instances Cell::GetInstances () const; /*! \function Instances Cell::getInstances () const;
* Returns the Collection of all instances called by the Cell. * Returns the Collection of all instances called by the Cell.
*/ */
/*! \function Instances Cell::GetInstancesUnder ( const Box& area ) const; /*! \function Instances Cell::getInstancesUnder ( const Box& area ) const;
* Returns the collection of all instances of the Cell intersecting the * Returns the collection of all instances of the Cell intersecting the
* given rectangular \e area. * given rectangular \e area.
*/ */
/*! \function Instances Cell::GetSlaveInstances () const; /*! \function Instances Cell::getSlaveInstances () const;
* Returns the Collection of instances whose master is this Cell. * Returns the Collection of instances whose master is this Cell.
*/ */
/*! \function Net* Cell::GetNet ( const Name& name ) const; /*! \function Net* Cell::getNet ( const Name& name ) const;
* Returns the Net of name \e name if it exists, else \NULL. * Returns the Net of name \e name if it exists, else \NULL.
*/ */
/*! \function Nets Cell::GetNets () const; /*! \function Nets Cell::getNets () const;
* Returns the Collection of all nets of the Cell. * Returns the Collection of all nets of the Cell.
*/ */
/*! \function Nets Cell::GetGlobalNets () const; /*! \function Nets Cell::getGlobalNets () const;
* Returns the Collection of all global nets of the Cell. * Returns the Collection of all global nets of the Cell.
*/ */
/*! \function Nets Cell::GetExternalNets () const; /*! \function Nets Cell::getExternalNets () const;
* Returns the Collection of all external nets of the Cell. * Returns the Collection of all external nets of the Cell.
*/ */
/*! \function Nets Cell::GetInternalNets () const; /*! \function Nets Cell::getInternalNets () const;
* Returns the Collection of all internal nets of the Cell. * Returns the Collection of all internal nets of the Cell.
*/ */
/*! \function Nets Cell::GetClockNets () const; /*! \function Nets Cell::getClockNets () const;
* Returns the Collection of all clock nets of the Cell. * Returns the Collection of all clock nets of the Cell.
*/ */
/*! \function Nets Cell::GetSupplyNets () const; /*! \function Nets Cell::getSupplyNets () const;
* Returns the Collection of all supply nets of the Cell. * Returns the Collection of all supply nets of the Cell.
*/ */
/*! \function Slice* Cell::GetSlice ( const Layer* layer ) const; /*! \function Slice* Cell::getSlice ( const Layer* layer ) const;
* Returns the Slice associated with the Layer \e layer if it exists, else \NULL. * Returns the Slice associated with the Layer \e layer if it exists, else \NULL.
*/ */
/*! \function Slices Cell::GetSlices ( const Layer::Mask& mask = ~0 ) const; /*! \function Slices Cell::getSlices ( const Layer::Mask& mask = ~0 ) const;
* Returns the Collection of slices of a Cell. * Returns the Collection of slices of a Cell.
*/ */
/*! \function Views Cell::GetViews () const; /* \function Views Cell::getViews () const;
* Returns the Collection of graphical views of a Cell. * Returns the Collection of graphical views of a Cell.
*/ */
/*! \function Views Cell::GetMainViews () const; /* \function Views Cell::getMainViews () const;
* Returns the Collection of main graphical views of a Cell. * Returns the Collection of main graphical views of a Cell.
*/ */
/*! \function Views Cell::GetImpactedMainViews () const; /* \function Views Cell::getImpactedMainViews () const;
* Returns the Collection of main graphical views we should update after * Returns the Collection of main graphical views we should update after
* a Cell has been modified. * a Cell has been modified.
* *
@ -107,11 +107,11 @@
* of cells which call directly or indirectly the Cell. * of cells which call directly or indirectly the Cell.
*/ */
/*! \function Rubbers Cell::GetRubbers () const; /*! \function Rubbers Cell::getRubbers () const;
* Returns the Collection of all Rubbers of a Cell. * Returns the Collection of all Rubbers of a Cell.
*/ */
/*! \function Rubbers Cell::GetRubbersUnder ( const Box& area ) const; /*! \function Rubbers Cell::getRubbersUnder ( const Box& area ) const;
* Returns the collection of all Rubbers of the Cell intersecting the * Returns the collection of all Rubbers of the Cell intersecting the
* given rectangular \e area. * given rectangular \e area.
* *
@ -119,11 +119,11 @@
* in this collection. * in this collection.
*/ */
/*! \function Components Cell::GetComponents ( const Layer::Mask& mask = ~0 ) const; /*! \function Components Cell::getComponents ( const Layer::Mask& mask = ~0 ) const;
* Returns the Collection of all Components of the Cell. * Returns the Collection of all Components of the Cell.
*/ */
/*! \function Components Cell::GetComponentsUnder ( const Box& area, const Layer::Mask& mask = ~0 ) const; /*! \function Components Cell::getComponentsUnder ( const Box& area, const Layer::Mask& mask = ~0 ) const;
* Returns the collection of all Components of the Cell intersecting the * Returns the collection of all Components of the Cell intersecting the
* given rectangular \e area. * given rectangular \e area.
* *
@ -131,7 +131,7 @@
* in this collection. * in this collection.
*/ */
/*! \function Occurrences Cell::GetOccurrences ( unsigned searchDepth=(unsigned)-1 ) const; /*! \function Occurrences Cell::getOccurrences ( unsigned searchDepth=(unsigned)-1 ) const;
* Returns the Collection of all Occurrences belonging to this Cell. * Returns the Collection of all Occurrences belonging to this Cell.
* *
* \remark The search depth is decremented each time a hirearchical * \remark The search depth is decremented each time a hirearchical
@ -139,7 +139,7 @@
* (the value \c INFINITE is equal to \c (unsigned)-1) . * (the value \c INFINITE is equal to \c (unsigned)-1) .
*/ */
/*! \function Occurrences Cell::GetOccurrencesUnder ( const Box& area, unsigned searchDepth=(unsigned)-1 ) const; /*! \function Occurrences Cell::getOccurrencesUnder ( const Box& area, unsigned searchDepth=(unsigned)-1 ) const;
* Returns the Collection of all Occurrences belonging to this Cell and * Returns the Collection of all Occurrences belonging to this Cell and
* intersecting the given rectangular area. * intersecting the given rectangular area.
* *
@ -151,12 +151,12 @@
* entities are taken into account in this Collection. * entities are taken into account in this Collection.
*/ */
/*! \function Box Cell::GetAbutmentBox () const; /*! \function Box Cell::getAbutmentBox () const;
* Returns Returns the abutment box of the cell (which is defined by the * Returns Returns the abutment box of the cell (which is defined by the
* designer unlike the bounding box which is managed dynamically). * designer unlike the bounding box which is managed dynamically).
*/ */
/*! \function Symbol* Cell::GetSymbol () const; /* \function Symbol* Cell::getSymbol () const;
* Returns the symbol associated to the cell. * Returns the symbol associated to the cell.
*/ */
@ -167,14 +167,14 @@
*/ */
// \{ // \{
/*! \function bool Cell::IsCalledBy ( Cell* cell ) const; /*! \function bool Cell::isCalledBy ( Cell* cell ) const;
* Returns \true if the cell \this is directly or indirectly called by * Returns \true if the cell \this is directly or indirectly called by
* the Cell \e cell. This functions allows to check that there is * the Cell \e cell. This functions allows to check that there is
* no cyclic instance calls of cells (it is by default, * no cyclic instance calls of cells (it is by default,
* automatically called when creating an instance). * automatically called when creating an instance).
*/ */
/*! \function bool Cell::IsTerminal () const; /*! \function bool Cell::isTerminal () const;
* Returns \true if the Cell is marked as terminal (meaning that it has * Returns \true if the Cell is marked as terminal (meaning that it has
* no inside or that we dont want to take it into account), else * no inside or that we dont want to take it into account), else
* \false. * \false.
@ -187,7 +187,7 @@
*/ */
// \{ // \{
/*! \function void Cell::SetName ( const Name& name ); /*! \function void Cell::setName ( const Name& name );
* Allows to change the Cell Name. * Allows to change the Cell Name.
* *
* \remark Throws an exception if the new \e name is empty or if the * \remark Throws an exception if the new \e name is empty or if the
@ -195,8 +195,8 @@
* name. * name.
*/ */
/*! \function void Cell::SetAbutmentBox ( const Box& abutmentBox ); /*! \function void Cell::setAbutmentBox ( const Box& abutmentBox );
* Sets Cell abutment box. * sets Cell abutment box.
* *
* \remark At the Cell creation the abutment box is empty. This one must * \remark At the Cell creation the abutment box is empty. This one must
* be set through this function. It is possible also, once * be set through this function. It is possible also, once
@ -204,19 +204,19 @@
* Box as argument. * Box as argument.
*/ */
/*! \function void Cell::SetTerminal ( bool state ); /*! \function void Cell::setTerminal ( bool state );
* Sets Cell terminal status to \e state. * sets Cell terminal status to \e state.
*/ */
/*! \function void Cell::SetSymbol ( Symbol* symbol ); /* \function void Cell::setSymbol ( Symbol* symbol );
* Associates the symbol \e symbol to the Cell. * Associates the symbol \e symbol to the Cell.
*/ */
/*! \function void Cell::Materialize (); /*! \function void Cell::materialize ();
* Materializes all components of all the nets of the Cell. * materializes all components of all the nets of the Cell.
*/ */
/*! \function void Cell::Unmaterialize (); /*! \function void Cell::unmaterialize ();
* De-materializes all components of all the nets of the Cell. * De-materializes all components of all the nets of the Cell.
*/ */

52
hurricane/doc/hurricane/Collection.dox
View File

@ -20,9 +20,9 @@
* area. * area.
* *
* *
* \section secGenericGetCollection The Generic GetCollection * \section secGenericgetCollection The Generic getCollection
* *
* The collections provide the generic \c GetCollection() * The collections provide the generic \c getCollection()
* function which allows to convert its argument into a generic * function which allows to convert its argument into a generic
* collection. It has no specific interest for Hurricane * collection. It has no specific interest for Hurricane
* collections, but this function is overloaded for STL containers. * collections, but this function is overloaded for STL containers.
@ -34,7 +34,7 @@ set<Instance*> instanceSet;
// here we fill the set with the desired instances... // here we fill the set with the desired instances...
for_each_instance(instance, GetCollection(instanceSet)) { for_each_instance(instance, getCollection(instanceSet)) {
// process here each instance of the set // process here each instance of the set
// (the elements are visited according to the set ordering) // (the elements are visited according to the set ordering)
end_for; end_for;
@ -52,14 +52,14 @@ for_each_instance(instance, GetCollection(instanceSet)) {
* \caution The returned collection is valid whenever the STL container * \caution The returned collection is valid whenever the STL container
* is valid. Then you should not do the following: * is valid. Then you should not do the following:
\code \code
GenericCollection<Instance*> GetInstances(...) GenericCollection<Instance*> getInstances(...)
// ******************************************* // *******************************************
{ {
set<Instance*> instanceSet; set<Instance*> instanceSet;
// we fill the container with the appropriate instances // we fill the container with the appropriate instances
return GetCollection(instanceSet); // instanceSet deleted after return return getCollection(instanceSet); // instanceSet deleted after return
} }
\endcode \endcode
* *
@ -69,7 +69,7 @@ GenericCollection<Instance*> GetInstances(...)
\code \code
Cell* cell = ... // we get the cell Cell* cell = ... // we get the cell
Nets nets = cellGetNets(); Nets nets = cellgetNets();
cellDelete(); cellDelete();
@ -134,7 +134,7 @@ for_each_net(net, nets) {
*/ */
// \{ // \{
/*! \function Collection<Type>* Collection::GetClone() const; /*! \function Collection<Type>* Collection::getClone() const;
* Allocates and returns a clone (copy) of the collection * Allocates and returns a clone (copy) of the collection
* (whatever be its type). * (whatever be its type).
* *
@ -144,7 +144,7 @@ for_each_net(net, nets) {
* that for you, as we will see later. * that for you, as we will see later.
*/ */
/*! \function Locator<Type>* Collection::GetLocator() const; /*! \function Locator<Type>* Collection::getLocator() const;
* Allocates and returns a locator adapted to visit the elements * Allocates and returns a locator adapted to visit the elements
* of the collection. * of the collection.
* *
@ -155,21 +155,21 @@ for_each_net(net, nets) {
* as we will see later. * as we will see later.
*/ */
/*! \function unsigned Collection::GetSize() const; /*! \function unsigned Collection::getSize() const;
* \Return the number of objects identified within the collection. * \Return the number of objects identified within the collection.
* *
* \remark Very fast in some cases, but may need to visit the collection * \remark Very fast in some cases, but may need to visit the collection
* in most ones. * in most ones.
*/ */
/*! \function Type Collection::GetFirst() const; /*! \function Type Collection::getFirst() const;
* \Return the first element of the collection. * \Return the first element of the collection.
* *
* \remark The result is meaningful only when the collection is non * \remark The result is meaningful only when the collection is non
* empty. * empty.
*/ */
/*! \function GenericCollection<SubType> Collection::GetSubSet<SubType>() const; /*! \function GenericCollection<SubType> Collection::getSubSet<SubType>() const;
* \Return the collection corresponding to the subset of elements of * \Return the collection corresponding to the subset of elements of
* type \c \<SubType\>. * type \c \<SubType\>.
* *
@ -177,27 +177,27 @@ for_each_net(net, nets) {
* <b>SubType</b> and not of type <b>Type</b>. * <b>SubType</b> and not of type <b>Type</b>.
* *
\code \code
Contacts Net::GetContacts() const Contacts Net::getContacts() const
// ****************************** // ******************************
{ {
return GetComponents().GetSubSet<Contact*>(); return getComponents().getSubSet<Contact*>();
} }
\endcode \endcode
*/ */
/*! \function GenericCollection<Type> Collection::GetSubSet(const Filter<Type>& filter) const; /*! \function GenericCollection<Type> Collection::getSubSet(const Filter<Type>& filter) const;
* \Return the collection representing the subset of elements accepted * \Return the collection representing the subset of elements accepted
* by the filter. * by the filter.
\code \code
Nets Cell::GetExternalNets() const Nets Cell::getExternalNets() const
// ******************************* // *******************************
{ {
return GetNets().GetSubSet(Net::GetIsExternalFilter()); return getNets().getSubSet(Net::getIsExternalFilter());
} }
\endcode \endcode
*/ */
/*! \function GenericCollection<SubType> Collection::GetSubSet<SubType>(const Filter<SubType>& filter) const; /*! \function GenericCollection<SubType> Collection::getSubSet<SubType>(const Filter<SubType>& filter) const;
* \Return the collection representing the subset of elements of type * \Return the collection representing the subset of elements of type
* \c \<SubType\> accepted by the filter. * \c \<SubType\> accepted by the filter.
* *
@ -232,14 +232,14 @@ class IsOnLayer : public Filter<Segment*> {
return *this; return *this;
}; };
virtual Filter<Net*>* GetClone() const virtual Filter<Net*>* getClone() const
{ {
return new IsOnLayer(*this); return new IsOnLayer(*this);
}; };
virtual bool Accept(Segment* segment) const virtual bool Accept(Segment* segment) const
{ {
return (segmentGetLayer() == _layer); return (segmentgetLayer() == _layer);
}; };
}; };
@ -247,9 +247,9 @@ class IsOnLayer : public Filter<Segment*> {
* *
* And somewher later: * And somewher later:
\code \code
Layer* metal = GetDataBase()GetTechnology()GetLayer("metal"); Layer* metal = getDataBase()getTechnology()getLayer("metal");
Segments segments = netGetComponents()->GetSubSet<Segment*>(IsOnLayer(metal)); Segments segments = netgetComponents()->getSubSet<Segment*>(IsOnLayer(metal));
// segments represents here the subset of net components // segments represents here the subset of net components
// which are of type Segment and located on layer metal // which are of type Segment and located on layer metal
@ -306,14 +306,14 @@ Segments segments = netGetComponents()->GetSubSet<Segment*>(IsOnLayer(metal));
Cell* cell = ...; // we get the cell Cell* cell = ...; // we get the cell
if (cell) { if (cell) {
for_each(Net*, net, cellGetExternalNets()) { for_each(Net*, net, cellgetExternalNets()) {
assert(netIsExternal()); assert(netIsExternal());
assert(netGetCell() == cell); assert(netgetCell() == cell);
end_for; end_for;
} }
} }
\endcode \endcode
* On this example the call to <b>cell-\>GetExternalNets()</b> * On this example the call to <b>cell-\>getExternalNets()</b>
* returns the collection of all external nets of the cell. Here * returns the collection of all external nets of the cell. Here
* the loop does some consistency checks on each net. As we will * the loop does some consistency checks on each net. As we will
* see later on there exist macros for each type of object which * see later on there exist macros for each type of object which
@ -323,9 +323,9 @@ if (cell) {
Cell* cell = ...; // we get the cell Cell* cell = ...; // we get the cell
if (cell) { if (cell) {
for_each_net(net, cellGetExternalNets()) { for_each_net(net, cellgetExternalNets()) {
assert(netIsExternal()); assert(netIsExternal());
assert(netGetCell() == cell); assert(netgetCell() == cell);
end_for; end_for;
} }
} }

4
hurricane/doc/hurricane/Commons.dox
View File

@ -9,12 +9,12 @@
* \{ * \{
*/ */
/*! \function string Demangle ( const char* symbol ); /*! \function string demangle ( const char* symbol );
* Translate (demangle) a symbol from C++ (\c gnu-v3) internal format * Translate (demangle) a symbol from C++ (\c gnu-v3) internal format
* into a human readable \string. * into a human readable \string.
*/ */
/*! \function string Demangle ( const type_info& info ); /*! \function string demangle ( const type_info& info );
* \param info a type_info structure as returned by \c typeid(). * \param info a type_info structure as returned by \c typeid().
* *
* Translate (demangle) a symbol from C++ (\c gnu-v3) internal format * Translate (demangle) a symbol from C++ (\c gnu-v3) internal format

52
hurricane/doc/hurricane/Component.dox
View File

@ -25,7 +25,7 @@
* *
* For that purpose each components must be able to return a * For that purpose each components must be able to return a
* location from which a relative calculations can be done. The * location from which a relative calculations can be done. The
* methods <b>GetX()</b> and <b>GetY()</b> provide this * methods <b>getX()</b> and <b>getY()</b> provide this
* information and must be overloaded for each sub-type of * information and must be overloaded for each sub-type of
* component in oder to get the desired effect. * component in oder to get the desired effect.
* *
@ -34,7 +34,7 @@
* of this methods means that the locations are computed * of this methods means that the locations are computed
* relative to a null value, which is equivalent to say they are * relative to a null value, which is equivalent to say they are
* absolute values (see for instance the Horizontal segment * absolute values (see for instance the Horizontal segment
* whose GetX() returns always null, while GetY() return the * whose getX() returns always null, while getY() return the
* ordinate of its axis). * ordinate of its axis).
* *
* \section secComponentDestruction Destruction * \section secComponentDestruction Destruction
@ -50,7 +50,7 @@
* *
* \section secComponentPredefinedFilters Predefined filters * \section secComponentPredefinedFilters Predefined filters
* *
* <b>Component::GetIsUnderFilter</b> * <b>Component::getIsUnderFilter</b>
*/ */
@ -71,37 +71,37 @@
*/ */
// \{ // \{
/*! \function Net* Component::GetNet() const; /*! \function Net* Component::getNet() const;
* \Return the net owning the component. * \Return the net owning the component.
*/ */
/*! \function Rubber* Component::GetRubber() const; /*! \function Rubber* Component::getRubber() const;
* \Return the rubber associated to the component (may be NULL). * \Return the rubber associated to the component (may be NULL).
*/ */
/*! \function Net::BodyHook* Component::GetBodyHook(); /*! \function Net::BodyHook* Component::getBodyHook();
* \Return the hook representing the component body. * \Return the hook representing the component body.
*/ */
/*! \function Hooks Component::GetHooks() const; /*! \function Hooks Component::getHooks() const;
* \Return the collection of component hooks, that is the collection of * \Return the collection of component hooks, that is the collection of
* nested hooks within the component, each of them representing * nested hooks within the component, each of them representing
* a part of the component. * a part of the component.
*/ */
/*! \function Unit Component::GetX() const; /*! \function Unit Component::getX() const;
* \Return the abscissa of the component's body. This abscissa is a * \Return the abscissa of the component's body. This abscissa is a
* reference base for the components anchored, through an * reference base for the components anchored, through an
* offset, on the component's body. * offset, on the component's body.
*/ */
/*! \function Unit Component::GetY() const; /*! \function Unit Component::getY() const;
* \Return the ordinate of the component's body. This ordinate is a * \Return the ordinate of the component's body. This ordinate is a
* reference base for the components anchored, through an * reference base for the components anchored, through an
* offset, on the component's body. * offset, on the component's body.
*/ */
/*! \function Point Component::GetPosition() const; /*! \function Point Component::getPosition() const;
* \Return the location of the component's body. * \Return the location of the component's body.
* *
* This method returns, in principle, a point built from the two * This method returns, in principle, a point built from the two
@ -109,24 +109,24 @@
* done in both methods, it is wise to redefine the method as * done in both methods, it is wise to redefine the method as
* shown below for the Contact : * shown below for the Contact :
\code \code
Unit Contact::GetX() const Unit Contact::getX() const
// *********************** // ***********************
{ {
Component* anchor = GetAnchor(); Component* anchor = getAnchor();
return (!anchor) ? _dx : anchorGetX() + _dx; return (!anchor) ? _dx : anchorGetX() + _dx;
} }
Unit Contact::GetY() const Unit Contact::getY() const
// *********************** // ***********************
{ {
Component* anchor = GetAnchor(); Component* anchor = getAnchor();
return (!anchor) ? _dy : anchorGetY() + _dy; return (!anchor) ? _dy : anchorGetY() + _dy;
} }
Point Contact::GetPosition() const Point Contact::getPosition() const
// ******************************* // *******************************
{ {
Component* anchor = GetAnchor(); Component* anchor = getAnchor();
return (!anchor) ? return (!anchor) ?
Point(_dx, _dy) : Point(_dx, _dy) :
anchorGetPosition().Translate(_dx, _dy); anchorGetPosition().Translate(_dx, _dy);
@ -139,24 +139,24 @@ Point Contact::GetPosition() const
* through an offset defined by two attributes _dx and _dy. In * through an offset defined by two attributes _dx and _dy. In
* order to compute the abscissa of a contact the component on * order to compute the abscissa of a contact the component on
* which it bears must be found. This component named the * which it bears must be found. This component named the
* <b>anchor</b> is returned by the call to GetAnchor(). If the * <b>anchor</b> is returned by the call to getAnchor(). If the
* component has no anchor, its coordinates are considered as * component has no anchor, its coordinates are considered as
* absolute and the attribute _dx gives directly its abscissa. * absolute and the attribute _dx gives directly its abscissa.
* *
* The method GetAnchor() must loop through a ring in order to * The method getAnchor() must loop through a ring in order to
* find the contact anchor. By overloading the function * find the contact anchor. By overloading the function
* GetPosition(), only one loop will be needed. Furtermore we * getPosition(), only one loop will be needed. Furtermore we
* call directly anchor-\>GetPosition() and not both * call directly anchor-\>getPosition() and not both
* anchor-\>GetX() and anchor-\>GetY(), this will be faster * anchor-\>getX() and anchor-\>getY(), this will be faster
* (this anchor may be anchored itself on an other component). * (this anchor may be anchored itself on an other component).
*/ */
/*! \function Layer* Component::GetLayer() const; /*! \function Layer* Component::getLayer() const;
* \Return the layer on which the component is located (may return NULL * \Return the layer on which the component is located (may return NULL
* for some component types like the plugs). * for some component types like the plugs).
*/ */
/*! \function Box Component::GetBoundingBox(BasicLayer* basicLayer) const; /*! \function Box Component::getBoundingBox(const BasicLayer* basicLayer) const;
* \Return the envelope of the component for the \c \<basicLayer\>, that * \Return the envelope of the component for the \c \<basicLayer\>, that
* is the smallest box enclosing all layout elements located on * is the smallest box enclosing all layout elements located on
* the specified basic layer. * the specified basic layer.
@ -166,14 +166,14 @@ Point Contact::GetPosition() const
* specified basic layer. * specified basic layer.
*/ */
/*! \function Components Component::GetSlaveComponents() const; /*! \function Components Component::getSlaveComponents() const;
* \Return the collection of components whose existence depends directly * \Return the collection of components whose existence depends directly
* or indirectly of the existence of the component \c \<this\> * or indirectly of the existence of the component \c \<this\>
* (a segment can't survive to the destruction of a contact on * (a segment can't survive to the destruction of a contact on
* which it is anchored). * which it is anchored).
*/ */
/*! \function Components Component::GetConnexComponents() const; /*! \function Components Component::getConnexComponents() const;
* \Return the collection of "connex components" to the component * \Return the collection of "connex components" to the component
* \c \<this\> (which includes at least this one). * \c \<this\> (which includes at least this one).
* *
@ -194,7 +194,7 @@ Point Contact::GetPosition() const
* electrical continuity will not be ensured. * electrical continuity will not be ensured.
*/ */
/*! \function ComponentFilter Component::GetIsUnderFilter(const Box& area); /*! \function ComponentFilter Component::getIsUnderFilter(const Box& area);
* \Return the filter allowing to select only components which intersect * \Return the filter allowing to select only components which intersect
* the rectangular \c \<area\>. * the rectangular \c \<area\>.
*/ */

40
hurricane/doc/hurricane/CompositeLayer.dox
View File

@ -40,8 +40,8 @@
*/ */
// \{ // \{
/*! \function CompositeLayer* CompositeLayer::Create(Technology* technology,const Name& name,const CompositeLayer::Type& type,const Unit& minimalSize = 0,const Unit& minimalSpacing = 0); /*! \function CompositeLayer* CompositeLayer::create(Technology* technology,const Name& name,const CompositeLayer::Type& type,const Unit& minimalSize = 0,const Unit& minimalSpacing = 0);
* Creates and returns a new composite layer named \c \<name\>, * creates and returns a new composite layer named \c \<name\>,
* of type \c \<type\> for the given technology (some * of type \c \<type\> for the given technology (some
* geometrical characteristics can also be specified). * geometrical characteristics can also be specified).
* *
@ -56,49 +56,49 @@
*/ */
// \{ // \{
/*! \function const CompositeLayer::Type& CompositeLayer::GetType() const; /*! \function const CompositeLayer::Type& CompositeLayer::getType() const;
* \Return the composite layer type. * \Return the composite layer type.
*/ */
/*! \function Unit CompositeLayer::GetContactSize(BasicLayer* basicLayer) const; /*! \function Unit CompositeLayer::getContactSize(const BasicLayer* basicLayer) const;
* \Return the contact size associated to the basic layer * \Return the contact size associated to the basic layer
* \c \<basicLayer\> (0 if this basic layer doesn't pertains to * \c \<basicLayer\> (0 if this basic layer doesn't pertains to
* composite one). * composite one).
*/ */
/*! \function Unit CompositeLayer::GetSegmentSize(BasicLayer* basicLayer) const; /*! \function Unit CompositeLayer::getSegmentSize(const BasicLayer* basicLayer) const;
* \Return the segment size associated to the basic layer * \Return the segment size associated to the basic layer
* \c \<basicLayer\> (0 if this basic layer doesn't pertains to * \c \<basicLayer\> (0 if this basic layer doesn't pertains to
* composite one). * composite one).
*/ */
/*! \function Unit CompositeLayer::GetSegmentExtention(BasicLayer* basicLayer) const; /*! \function Unit CompositeLayer::getSegmentExtention(const BasicLayer* basicLayer) const;
* \Return the segment extension associated to the basic layer * \Return the segment extension associated to the basic layer
* \c \<basicLayer\> (0 if this basic layer doesn't pertains to * \c \<basicLayer\> (0 if this basic layer doesn't pertains to
* composite one). * composite one).
*/ */
/*! \function Unit CompositeLayer::GetPadSize(BasicLayer* basicLayer) const; /*! \function Unit CompositeLayer::getPadSize(const BasicLayer* basicLayer) const;
* \Return the pad size associated to the basic layer \c \<basicLayer\> * \Return the pad size associated to the basic layer \c \<basicLayer\>
* (0 if this basic layer doesn't pertains to composite one). * (0 if this basic layer doesn't pertains to composite one).
*/ */
/*! \function const Unit& CompositeLayer::GetMaximalContactSize() const; /*! \function const Unit& CompositeLayer::getMaximalContactSize() const;
* \Return the maximum contact size for all the basic layers composing * \Return the maximum contact size for all the basic layers composing
* the composite layer. * the composite layer.
*/ */
/*! \function const Unit& CompositeLayer::GetMaximalSegmentSize() const; /*! \function const Unit& CompositeLayer::getMaximalSegmentSize() const;
* \Return the maximum segment size for all the basic layers composing * \Return the maximum segment size for all the basic layers composing
* the composite layer. * the composite layer.
*/ */
/*! \function const Unit& CompositeLayer::GetMaximalSegmentExtention() const; /*! \function const Unit& CompositeLayer::getMaximalSegmentExtention() const;
* \Return the maximum segment extension for all the basic layers * \Return the maximum segment extension for all the basic layers
* composing the composite layer. * composing the composite layer.
*/ */
/*! \function const Unit& CompositeLayer::GetMaximalPadSize() const; /*! \function const Unit& CompositeLayer::getMaximalPadSize() const;
* \Return the maximum pad size for all the basic layers composing the * \Return the maximum pad size for all the basic layers composing the
* composite layer. * composite layer.
*/ */
@ -110,8 +110,8 @@
*/ */
// \{ // \{
/*! \function void CompositeLayer::Add(BasicLayer* basicLayer,const Unit& contactSize,const Unit& segmentSize,const Unit& segmentExtention,const Unit& padSize); /*! \function void CompositeLayer::add(BasicLayer* basicLayer,const Unit& contactSize,const Unit& segmentSize,const Unit& segmentExtention,const Unit& padSize);
* Adds the basic layer with associated characteristics * adds the basic layer with associated characteristics
* specified by the other arguments. * specified by the other arguments.
* *
* \caution Throws an exception if the basic layer is null or already * \caution Throws an exception if the basic layer is null or already
@ -119,16 +119,16 @@
* *
* Usage example : * Usage example :
\code \code
DataBase* dataBase = GetDataBase(); DataBase* dataBase = getDataBase();
Technology* technology = dataBaseGetTechnology(); Technology* technology = dataBaseGetTechnology();
CompositeLayer* metal2 = technologyGetCompositeLayer("metal2"): CompositeLayer* metal2 = technologyGetCompositeLayer("metal2"):
Unit contactSize = GetUnit(0.5); Unit contactSize = getUnit(0.5);
Unit segmentSize = GetUnit(1.0); Unit segmentSize = getUnit(1.0);
Unit segmentExtention = GetUnit(1.3); Unit segmentExtention = getUnit(1.3);
Unit padSize = GetUnit(0); Unit padSize = getUnit(0);
BasicLayer* CM2 = technologyGetBasicLayer("CM2"); BasicLayer* CM2 = technologyGetBasicLayer("CM2");
@ -143,8 +143,8 @@ assert(metal2GetPadSize(CM2) == padSize);
* *
*/ */
/*! \function void CompositeLayer::Remove(BasicLayer* basicLayer); /*! \function void CompositeLayer::remove(BasicLayer* basicLayer);
* Removes the basic layer from the composite layer. * removes the basic layer from the composite layer.
* *
* \caution Throws an exception if the basic layer is null or it doesn't * \caution Throws an exception if the basic layer is null or it doesn't
* pertain to the composite layer. * pertain to the composite layer.

58
hurricane/doc/hurricane/Contact.dox
View File

@ -42,8 +42,8 @@
*/ */
// \{ // \{
/*! \function Contact* Contact::Create(Net* net, Layer* layer, const Unit& x, const Unit& y,const Unit& width = 0, const Unit& height = 0); /*! \function Contact* Contact::create(Net* net, Layer* layer, const Unit& x, const Unit& y,const Unit& width = 0, const Unit& height = 0);
* Creates and returns a new contact belonging to the net * creates and returns a new contact belonging to the net
* \c \<net\>, on the layer \c \<layer\>, of size \c \<width\> * \c \<net\>, on the layer \c \<layer\>, of size \c \<width\>
* and \c \<height\> and located at the absolute coordinates * and \c \<height\> and located at the absolute coordinates
* \c \<x\> and \c \<y\>. * \c \<x\> and \c \<y\>.
@ -51,8 +51,8 @@
* \caution Throws an exception if the layer or the net is null. * \caution Throws an exception if the layer or the net is null.
*/ */
/*! \function Contact* Contact::Create(Component* anchor, Layer* layer, const Unit& dx, const Unit& dy,const Unit& width = 0, const Unit& height = 0); /*! \function Contact* Contact::create(Component* anchor, Layer* layer, const Unit& dx, const Unit& dy,const Unit& width = 0, const Unit& height = 0);
* Creates and returns a new contact on the layer \c \<layer\>, * creates and returns a new contact on the layer \c \<layer\>,
* of size \c \<width\> and \c \<height\> attached upon the * of size \c \<width\> and \c \<height\> attached upon the
* component \c \<anchor\> through an offset defined by * component \c \<anchor\> through an offset defined by
* \c \<dx\> et \c \<dy\>. * \c \<dx\> et \c \<dy\>.
@ -70,12 +70,12 @@
*/ */
// \{ // \{
/*! \function Contact::AnchorHook* Contact::GetAnchorHook(); /*! \function Contact::AnchorHook* Contact::getAnchorHook();
* \Return the hook through which the contact can be attached upon an * \Return the hook through which the contact can be attached upon an
* anchor. * anchor.
*/ */
/*! \function Component* Contact::GetAnchor() const; /*! \function Component* Contact::getAnchor() const;
* The anchor hook of the contact being a slave one, it may have * The anchor hook of the contact being a slave one, it may have
* a master hook representing the body of the anchor on which it * a master hook representing the body of the anchor on which it
* is attached. This method returns the owner of this master * is attached. This method returns the owner of this master
@ -85,33 +85,33 @@
* transitory)). * transitory)).
*/ */
/*! \function const Unit& Contact::GetDx() const; /*! \function const Unit& Contact::getDx() const;
* \Return the relative abscissa of the contact. * \Return the relative abscissa of the contact.
* *
* \remark If you want to get the absolute one use the member function * \remark If you want to get the absolute one use the member function
* GetX() defined at the Component level. * getX() defined at the Component level.
*/ */
/*! \function const Unit& Contact::GetDy() const; /*! \function const Unit& Contact::getDy() const;
* \Return the relative ordinate of the contact. * \Return the relative ordinate of the contact.
* *
* \remark If you want to get the absolute one use the member function * \remark If you want to get the absolute one use the member function
* GetY() defined at the Component level. * getY() defined at the Component level.
*/ */
/*! \function const Unit& Contact::GetWidth() const; /*! \function const Unit& Contact::getWidth() const;
* \Return the contact width. * \Return the contact width.
*/ */
/*! \function Unit Contact::GetHalfWidth() const; /*! \function Unit Contact::getHalfWidth() const;
* \Return the contact half width. * \Return the contact half width.
*/ */
/*! \function const Unit& Contact::GetHeight() const; /*! \function const Unit& Contact::getHeight() const;
* \Return the contact height. * \Return the contact height.
*/ */
/*! \function Unit Contact::GetHalfHeight() const; /*! \function Unit Contact::getHalfHeight() const;
* \Return the contact half height. * \Return the contact half height.
*/ */
@ -122,59 +122,59 @@
*/ */
// \{ // \{
/*! \function void Contact::SetLayer(Layer* layer); /*! \function void Contact::setLayer(Layer* layer);
* Sets the contact layer. * sets the contact layer.
*/ */
/*! \function void Contact::SetWidth(const Unit& width); /*! \function void Contact::setWidth(const Unit& width);
* Sets the contact width. * sets the contact width.
*/ */
/*! \function void Contact::SetHeight(const Unit& height); /*! \function void Contact::setHeight(const Unit& height);
* Sets the contact height. * sets the contact height.
*/ */
/*! \function void Contact::SetSizes(const Unit& width, const Unit& height); /*! \function void Contact::setSizes(const Unit& width, const Unit& height);
* Sets both contact width and height. * sets both contact width and height.
*/ */
/*! \function void Contact::SetX(const Unit& x); /*! \function void Contact::setX(const Unit& x);
* Allows to change the absolute abscissa of the contact (if it * Allows to change the absolute abscissa of the contact (if it
* has a location relative to an other component, only relative * has a location relative to an other component, only relative
* position to this last is accordingly changed). * position to this last is accordingly changed).
*/ */
/*! \function void Contact::SetY(const Unit& y); /*! \function void Contact::setY(const Unit& y);
* Allows to change the absolute ordinate of the contact (if it * Allows to change the absolute ordinate of the contact (if it
* has a location relative to an other component, only relative * has a location relative to an other component, only relative
* position to this last is accordingly changed). * position to this last is accordingly changed).
*/ */
/*! \function void Contact::SetPosition(const Unit& x, const Unit& y); /*! \function void Contact::setPosition(const Unit& x, const Unit& y);
* No description. * No description.
*/ */
/*! \function void Contact::SetPosition(const Point& position); /*! \function void Contact::setPosition(const Point& position);
* Allows to change the absolute location of the contact (if it * Allows to change the absolute location of the contact (if it
* has a location relative to an other component, only relative * has a location relative to an other component, only relative
* position to this last is accordingly changed). * position to this last is accordingly changed).
*/ */
/*! \function void Contact::SetDx(const Unit& dx); /*! \function void Contact::setDx(const Unit& dx);
* Allows to change the horizontal offset of the contact. * Allows to change the horizontal offset of the contact.
* *
* \remark If the contact is absolute, this amounts to change its * \remark If the contact is absolute, this amounts to change its
* absolute abscissa. * absolute abscissa.
*/ */
/*! \function void Contact::SetDy(const Unit& dy); /*! \function void Contact::setDy(const Unit& dy);
* Allows to change the vertical offset of the contact. * Allows to change the vertical offset of the contact.
* *
* \remark If the contact is absolute, this amounts to change its * \remark If the contact is absolute, this amounts to change its
* absolute ordinate. * absolute ordinate.
*/ */
/*! \function void Contact::SetOffset(const Unit& dx, const Unit& dy); /*! \function void Contact::setOffset(const Unit& dx, const Unit& dy);
* Allows to change the offset of the contact. * Allows to change the offset of the contact.
* *
* \remark If the contact is absolute, this amounts to change its * \remark If the contact is absolute, this amounts to change its

32
hurricane/doc/hurricane/DBo.dox
View File

@ -222,7 +222,7 @@
*/ */
/*! \function void DBo::Delete (); /*! \function void DBo::destroy ();
* *
* The legal method to delete any DBo object (see \ref sDBoDelete). * The legal method to delete any DBo object (see \ref sDBoDelete).
*/ */
@ -231,14 +231,14 @@
*/ */
// \{ // \{
/*! \function Property* DBo::GetProperty ( const Name& name ) const; /*! \function Property* DBo::getProperty ( const Name& name ) const;
* \param name Name of the Property to return. * \param name Name of the Property to return.
* \return The property of Name \e name attached to the object, if it exists, else \NULL. * \return The property of Name \e name attached to the object, if it exists, else \NULL.
* *
* \remark When writting what follows : * \remark When writting what follows :
* \code * \code
for_each_dbo(dbo, dbos) { for_each_dbo(dbo, dbos) {
Property* property = dbo->GetProperty("width"); Property* property = dbo->getProperty("width");
if (property) { if (property) {
// do something // do something
} }
@ -252,7 +252,7 @@
* \code * \code
Name width = "width"; Name width = "width";
for_each_dbo(dbo, dbos) { for_each_dbo(dbo, dbos) {
Property* property = dbo->GetProperty(width); Property* property = dbo->getProperty(width);
if (property) { if (property) {
// do something // do something
} }
@ -263,7 +263,7 @@
* \code * \code
static Name WIDTH = "width"; static Name WIDTH = "width";
for_each_dbo(dbo, dbos) { for_each_dbo(dbo, dbos) {
Property* property = dbo->GetProperty(WIDTH); Property* property = dbo->getProperty(WIDTH);
if (property) { if (property) {
// do something // do something
} }
@ -273,7 +273,7 @@
* This remark applies each time you handle names. * This remark applies each time you handle names.
*/ */
/*! \function Propertes DBo::GetProperties () const; /*! \function Propertes DBo::getProperties () const;
* \return The property Collection associated to the object (possibly empty). * \return The property Collection associated to the object (possibly empty).
*/ */
@ -284,7 +284,7 @@
*/ */
// \{ // \{
/*! \function bool DBo::HasProperty () const; /*! \function bool DBo::hasProperty () const;
* \return \true if the object has at least a property, else \false. * \return \true if the object has at least a property, else \false.
*/ */
@ -295,7 +295,7 @@
*/ */
// \{ // \{
/*! \function void DBo::Put ( Property* property ); /*! \function void DBo::put ( Property* property );
* *
* Adds the Property \e property to the set of object * Adds the Property \e property to the set of object
* properties. Properties being named, if an other one already * properties. Properties being named, if an other one already
@ -308,20 +308,20 @@
* \caution An exception is thrown if the Property pointer is \NULL. * \caution An exception is thrown if the Property pointer is \NULL.
*/ */
/*! \function void DBo::Remove ( Property* property ); /*! \function void DBo::remove ( Property* property );
* Removes the property \e property from the set of object properties. * removes the property \e property from the set of object properties.
* *
* \remark Does nothing if the Property object is not attached to the object. * \remark Does nothing if the Property object is not attached to the object.
* *
* \caution An exception is thrown if the Property pointer is \NULL. * \caution An exception is thrown if the Property pointer is \NULL.
*/ */
/*! \function void DBo::RemoveProperty ( const Name& name ); /*! \function void DBo::removeProperty ( const Name& name );
* Removes the property of name \e name if it exists. * removes the property of name \e name if it exists.
*/ */
/*! \function void DBo::ClearProperties (); /*! \function void DBo::clearProperties ();
* Removes all properties attached to this object. * removes all properties attached to this object.
*/ */
// \} // \}
@ -352,11 +352,11 @@
} }
/* \addtogroup GetStringFunctions /* \addtogroup getStringFunctions
*/ */
// \{ // \{
/* \function string GetString ( const Hurricane::DBo& dbo ); /* \function string getString ( const Hurricane::DBo& dbo );
* Convert any Hurricane::DBo object into a \string. * Convert any Hurricane::DBo object into a \string.
*/ */

10
hurricane/doc/hurricane/DataBase.dox
View File

@ -30,8 +30,8 @@
*/ */
// \{ // \{
/*! \function DataBase* DataBase::Create (); /*! \function DataBase* DataBase::create ();
* Creates and returns a pointer to a new DataBase. * creates and returns a pointer to a new DataBase.
* *
* \caution An exception is thrown if a Database already exists. * \caution An exception is thrown if a Database already exists.
*/ */
@ -43,11 +43,11 @@
*/ */
// \{ // \{
/*! \function Technology* DataBase::GetTechnology () const; /*! \function Technology* DataBase::getTechnology () const;
* \return the Technology if it exists, else \NULL. * \return the Technology if it exists, else \NULL.
*/ */
/*! \function Technology* DataBase::GetRootLibrary () const; /*! \function Technology* DataBase::getRootLibrary () const;
* \return the root Library if it exists, else \NULL. * \return the root Library if it exists, else \NULL.
*/ */
@ -58,7 +58,7 @@
* \{ * \{
*/ */
/*! \function DataBase* GetDataBase (); /*! \function DataBase* getDataBase ();
* This global generic function returns the current * This global generic function returns the current
* DataBase, if it has been created and not destroyed, * DataBase, if it has been created and not destroyed,
* else \NULL. * else \NULL.

4
hurricane/doc/hurricane/Entity.dox
View File

@ -18,12 +18,12 @@
*/ */
// \{ // \{
/*! \function Cell* Entity::GetCell () const; /*! \function Cell* Entity::getCell () const;
* \return Returns the cell owning this entity (when the Entity is a Cell, * \return Returns the cell owning this entity (when the Entity is a Cell,
* the Cell itself is returned) * the Cell itself is returned)
*/ */
/*! \function Box Entity::GetBoundingBox () const; /*! \function Box Entity::getBoundingBox () const;
* \return Returns the bounding box of the entity. It is defined as the * \return Returns the bounding box of the entity. It is defined as the
* smallest box enclosing the entity or its constituents. * smallest box enclosing the entity or its constituents.
* *

8
hurricane/doc/hurricane/Exception.dox
View File

@ -12,11 +12,9 @@
* The Exception class groups all exceptions thrown by functions * The Exception class groups all exceptions thrown by functions
* from the API. This virtual class is only useful to catch * from the API. This virtual class is only useful to catch
* exceptions originating from one of those functions. * exceptions originating from one of those functions.
*/ *
*
* \section secExceptionExample Example
/*! \section secExceptionExample Example
* *
\code \code
try { try {

42
hurricane/doc/hurricane/Filter.dox
View File

@ -27,7 +27,7 @@
*/ */
// \{ // \{
/*! \function Filter<Type>* Filter::GetClone() const; /*! \function Filter<Type>* Filter::getClone() const;
* \Return a filter copy. * \Return a filter copy.
*/ */
@ -38,7 +38,7 @@
*/ */
// \{ // \{
/*! \function bool Filter::Accept(Type element) const; /*! \function bool Filter::accept(Type element) const;
* This member function returns \true if the filter accepts the * This member function returns \true if the filter accepts the
* element else \false. * element else \false.
*/ */
@ -73,28 +73,28 @@ class IsExternal : public Filter<Net*> {
IsExternal& operator=(const IsExternal& isExternal) {return *this;}; IsExternal& operator=(const IsExternal& isExternal) {return *this;};
virtual Filter<Net*>* GetClone() const {return new IsExternal(*this);}; virtual Filter<Net*>* getClone() const {return new IsExternal(*this);};
virtual bool Accept(Net* net) const {return netIsExternal();}; virtual bool accept(Net* net) const {return netIsExternal();};
}; };
\endcode \endcode
* Implementation of the accessor <b>GetExternalNets</b> for the * Implementation of the accessor <b>getExternalNets</b> for the
* cells : * cells :
\code \code
Nets Cell::GetExternalNet() const Nets Cell::getExternalNet() const
// ****************************** // ******************************
{ {
return GetNets().GetSubSet(IsExternal()); return getNets().getSubSet(IsExternal());
} }
\endcode \endcode
* Similarly, the accessor <b>GetInternalNets</b> can be * Similarly, the accessor <b>getInternalNets</b> can be
* implemented using the <b>!</b> operator : * implemented using the <b>!</b> operator :
\code \code
Nets Cell::GetInternalNets() const Nets Cell::getInternalNets() const
// ******************************* // *******************************
{ {
return GetNets().GetSubSet(!IsExternal()); return getNets().getSubSet(!IsExternal());
} }
\endcode \endcode
*/ */
@ -107,7 +107,7 @@ Nets Cell::GetInternalNets() const
* filter with a simpler interface. Now the filters as they are * filter with a simpler interface. Now the filters as they are
* defined open the door to much more complex processing. * defined open the door to much more complex processing.
* *
* As a matter of fact the function <b>Accept</b> receives only * As a matter of fact the function <b>accept</b> receives only
* one argument which represents the element of the collection * one argument which represents the element of the collection
* to be accepted or rejected. * to be accepted or rejected.
* *
@ -136,9 +136,9 @@ class MyFilter : public Filter<Net*> {
return *this; return *this;
}; };
virtual Filter<Net*>* GetClone() const {return new MyFilter(*this);}; virtual Filter<Net*>* getClone() const {return new MyFilter(*this);};
virtual bool Accept(Net* net) const virtual bool accept(Net* net) const
{ {
return netIsExternal() && (netGetName()[0] == _c); return netIsExternal() && (netGetName()[0] == _c);
}; };
@ -147,9 +147,9 @@ class MyFilter : public Filter<Net*> {
\endcode \endcode
* Afterwards do * Afterwards do
\code \code
for_each_net(net, cellGetNets().GetSubSet(MyFilter('k'))) { for_each_net(net, cellGetNets().getSubSet(MyFilter('k'))) {
assert(net->IsExternal()); assert(net->IsExternal());
assert(net->GetName()[0] == 'k'); assert(net->getName()[0] == 'k');
cerr << "net: " << net << endl; cerr << "net: " << net << endl;
end_for; end_for;
} }
@ -169,7 +169,7 @@ for_each_net(net, cellGetNets().GetSubSet(MyFilter('k'))) {
* this : * this :
\code \code
for_each_net(net, cellGetNets()) { for_each_net(net, cellGetNets()) {
if (netIsExternal() && (net->GetName()[0] == 'k')) if (netIsExternal() && (net->getName()[0] == 'k'))
cerr << "net: " << net << endl; cerr << "net: " << net << endl;
end_for; end_for;
} }
@ -177,7 +177,7 @@ for_each_net(net, cellGetNets()) {
* or more simply : * or more simply :
\code \code
for_each_net(net, cellGetExternalNets()) { for_each_net(net, cellGetExternalNets()) {
if (net->GetName()[0] == 'k') if (net->getName()[0] == 'k')
cerr << "net: " << net << endl; cerr << "net: " << net << endl;
end_for; end_for;
} }
@ -185,20 +185,20 @@ for_each_net(net, cellGetExternalNets()) {
* Filters are objects like any other : they can be passed as * Filters are objects like any other : they can be passed as
* function arguments as shown below : * function arguments as shown below :
\code \code
Nets Cell::GetNets(const GenericFilter<Net*>& filter) const Nets Cell::getNets(const GenericFilter<Net*>& filter) const
// ******************************************************** // ********************************************************
{ {
return GetNets().GetSubSet(filter); return getNets().getSubSet(filter);
} }
\endcode \endcode
* As far as the type <b>NetFilter</b> is defined as being a * As far as the type <b>NetFilter</b> is defined as being a
* <b>GenericFilter\<Net*\></b> the previous function can be * <b>GenericFilter\<Net*\></b> the previous function can be
* written like this : * written like this :
\code \code
Nets Cell::GetNets(const NetFilter& filter) const Nets Cell::getNets(const NetFilter& filter) const
// ********************************************** // **********************************************
{ {
return GetNets().GetSubSet(filter); return getNets().getSubSet(filter);
} }
\endcode \endcode
*/ */

32
hurricane/doc/hurricane/Hook.dox
View File

@ -99,14 +99,14 @@
*/ */
// \{ // \{
/*! \function Component* Hook::GetComponent() const; /*! \function Component* Hook::getComponent() const;
* \Return the component whose hook represents a part. * \Return the component whose hook represents a part.
* *
* \remark The result is never NULL because hooks are byforce nested * \remark The result is never NULL because hooks are byforce nested
* objects in their component. * objects in their component.
*/ */
/*! \function Hook* Hook::GetNextHook() const; /*! \function Hook* Hook::getNextHook() const;
* \Return the next hook within the ring. * \Return the next hook within the ring.
* *
* \remark The result is never NULL because every hook has by * \remark The result is never NULL because every hook has by
@ -114,14 +114,14 @@
* empty). * empty).
*/ */
/*! \function Hook* Hook::GetPreviousHook() const; /*! \function Hook* Hook::getPreviousHook() const;
* \Return the previous hook within the ring. * \Return the previous hook within the ring.
* *
* \remark Less efficient than GetNextHook because it requires a * \remark Less efficient than getNextHook because it requires a
* complete ring loop. * complete ring loop.
*/ */
/*! \function Hook* Hook::GetMasterHook() const; /*! \function Hook* Hook::getMasterHook() const;
* \Return the master of the relation master-slaves identified by the * \Return the master of the relation master-slaves identified by the
* hook. * hook.
* *
@ -129,7 +129,7 @@
* the hook is a slave and has no associated master. * the hook is a slave and has no associated master.
*/ */
/*! \function Hook* Hook::GetNextMasterHook() const; /*! \function Hook* Hook::getNextMasterHook() const;
* \Return the first master found when starting the search immediately * \Return the first master found when starting the search immediately
* after the given hook. * after the given hook.
* *
@ -138,7 +138,7 @@
* the ring. * the ring.
*/ */
/*! \function Hook* Hook::GetPreviousMasterHook() const; /*! \function Hook* Hook::getPreviousMasterHook() const;
* \Return the first master found when starting a backwards search * \Return the first master found when starting a backwards search
* immediately before the given hook. * immediately before the given hook.
* *
@ -150,7 +150,7 @@
* (else it would be trully inefficient). * (else it would be trully inefficient).
*/ */
/*! \function Hooks Hook::GetHooks() const; /*! \function Hooks Hook::getHooks() const;
* \Return the collection of hooks of the ring containing the given * \Return the collection of hooks of the ring containing the given
* hook. * hook.
* *
@ -158,7 +158,7 @@
* the hook itself. * the hook itself.
*/ */
/*! \function Hooks Hook::GetSlaveHooks() const; /*! \function Hooks Hook::getSlaveHooks() const;
* \Return the hook collection which are slaves of the given hook. * \Return the hook collection which are slaves of the given hook.
* *
* \remarks This collection will be empty if the given hook is not a * \remarks This collection will be empty if the given hook is not a
@ -179,14 +179,14 @@
*/ */
// \{ // \{
/*! \function bool Hook::IsMaster() const; /*! \function bool Hook::isMaster() const;
* \Return \true if the hook must be considered as a master, else * \Return \true if the hook must be considered as a master, else
* \false. * \false.
* *
* \remark For any new kind of hook this predicate must be overloaded. * \remark For any new kind of hook this predicate must be overloaded.
*/ */
/*! \function bool Hook::IsAttached() const; /*! \function bool Hook::isAttached() const;
* If the hook is a slave : * If the hook is a slave :
* *
* \Return \true if the hook has an associated master, else \false. * \Return \true if the hook has an associated master, else \false.
@ -210,10 +210,10 @@
*/ */
// \{ // \{
/*! \function Hook* Hook::Detach(); /*! \function Hook* Hook::detach();
* If the hook is a slave : * If the hook is a slave :
* *
* Detaches the hook from its ring and returns its old * detaches the hook from its ring and returns its old
* predecessor. * predecessor.
* *
* \remark Will return NULL if the hook is the only one in the ring. * \remark Will return NULL if the hook is the only one in the ring.
@ -233,7 +233,7 @@
* The returned hook, if not NULL, is byforce a master. * The returned hook, if not NULL, is byforce a master.
*/ */
/*! \function Hook* Hook::Attach(Hook* masterHook); /*! \function Hook* Hook::attach(Hook* masterHook);
* If the hook (this) is a slave : * If the hook (this) is a slave :
* *
* The function inserts the hook immediately before * The function inserts the hook immediately before
@ -254,8 +254,8 @@
* \c \<masterHook\> is not a master hook. * \c \<masterHook\> is not a master hook.
*/ */
/*! \function Hook* Hook::Merge(Hook* masterHook); /*! \function Hook* Hook::merge(Hook* masterHook);
* Merges the rings represented by the two hooks which both must * merges the rings represented by the two hooks which both must
* be masters, returns \c \<masterHook\>. * be masters, returns \c \<masterHook\>.
* *
* \remark Throws an exception if both hooks are not masters. * \remark Throws an exception if both hooks are not masters.

22
hurricane/doc/hurricane/Horizontal.dox
View File

@ -38,12 +38,12 @@
*/ */
// \{ // \{
/*! \function Horizontal* Horizontal::Create(Component* source, Component* target, Layer* layer,const Unit& y, const Unit& width = 0,const Unit& dxSource = 0, const Unit& dxTarget = 0); /*! \function Horizontal* Horizontal::create(Component* source, Component* target, Layer* layer,const Unit& y, const Unit& width = 0,const Unit& dxSource = 0, const Unit& dxTarget = 0);
* No description. * No description.
*/ */
/*! \function Horizontal* Horizontal::Create(Net* net, Layer* layer, const Unit& y, const Unit& width = 0,const Unit& dxSource = 0, const Unit& dxTarget = 0); /*! \function Horizontal* Horizontal::create(Net* net, Layer* layer, const Unit& y, const Unit& width = 0,const Unit& dxSource = 0, const Unit& dxTarget = 0);
* Creates and returns an absolute horizontal segment with layer * creates and returns an absolute horizontal segment with layer
* \c \<layer\>, located at ordinate \c \<y\> and of width * \c \<layer\>, located at ordinate \c \<y\> and of width
* \c \<width\>. The differents extremities abscissas are given * \c \<width\>. The differents extremities abscissas are given
* by \c \<dxSource\> and \c \<dxTarget\>. * by \c \<dxSource\> and \c \<dxTarget\>.
@ -59,20 +59,20 @@
*/ */
// \{ // \{
/*! \function const Unit& Horizontal::GetDxSource() const; /*! \function const Unit& Horizontal::getDxSource() const;
* \Return the relative source abscissa of the segment (may be absolute * \Return the relative source abscissa of the segment (may be absolute
* if the source extremity isn't anchored). * if the source extremity isn't anchored).
* *
* \remark If you want to get the absolute one use the member function * \remark If you want to get the absolute one use the member function
* GetSourceY() defined at the Segment level. * getSourceY() defined at the Segment level.
*/ */
/*! \function const Unit& Horizontal::GetDxTarget() const; /*! \function const Unit& Horizontal::getDxTarget() const;
* \Return the relative target abscissa of the segment (may be absolute * \Return the relative target abscissa of the segment (may be absolute
* if the target extremity isn't anchored). * if the target extremity isn't anchored).
* *
* \remark If you want to get the absolute one use the member function * \remark If you want to get the absolute one use the member function
* GetTargetY() defined at the Segment level. * getTargetY() defined at the Segment level.
*/ */
// \} // \}
@ -82,12 +82,12 @@
*/ */
// \{ // \{
/*! \function void Horizontal::SetY(const Unit& x); /*! \function void Horizontal::setY(const Unit& x);
* Sets the ordinate of the segment. * sets the ordinate of the segment.
*/ */
/*! \function void Horizontal::Translate(const Unit& dy); /*! \function void Horizontal::translate(const Unit& dy);
* Translate verticaly the horizontal segment of the quantity * translate verticaly the horizontal segment of the quantity
* \c \<dy\>. * \c \<dy\>.
*/ */

44
hurricane/doc/hurricane/Interval.dox
View File

@ -78,35 +78,35 @@
*/ */
// \{ // \{
/*! \function const Unit& Interval::GetVMin() const; /*! \function const Unit& Interval::getVMin() const;
* \Return the VMin value : meaningful only for a non empty interval. * \Return the VMin value : meaningful only for a non empty interval.
*/ */
/*! \function const Unit& Interval::GetVMax() const; /*! \function const Unit& Interval::getVMax() const;
* \Return the VMax value : meaningful only for a non empty interval. * \Return the VMax value : meaningful only for a non empty interval.
*/ */
/*! \function Unit Interval::GetCenter() const; /*! \function Unit Interval::getCenter() const;
* \Return the interval center value : meaningful only for a non empty * \Return the interval center value : meaningful only for a non empty
* interval. * interval.
*/ */
/*! \function Unit Interval::GetSize() const; /*! \function Unit Interval::getSize() const;
* \Return the interval size : meaningful only for a non empty interval. * \Return the interval size : meaningful only for a non empty interval.
*/ */
/*! \function Unit Interval::GetHalfSize() const; /*! \function Unit Interval::getHalfSize() const;
* \Return the half interval width : meaningful only for a non empty * \Return the half interval width : meaningful only for a non empty
* interval. * interval.
*/ */
/*! \function Interval Interval::GetUnion(const Interval& interval) const; /*! \function Interval Interval::getUnion(const Interval& interval) const;
* \Return the smallest enclosing interval containing the intervals * \Return the smallest enclosing interval containing the intervals
* \c \<this\> and \c \<interval\>. The returned interval may be * \c \<this\> and \c \<interval\>. The returned interval may be
* empty if both are. * empty if both are.
*/ */
/*! \function Interval Interval::GetIntersection(const Interval& interval) const; /*! \function Interval Interval::getIntersection(const Interval& interval) const;
* \Return interval representing the overlapping region. This interval * \Return interval representing the overlapping region. This interval
* is empty if either one of the two intervals is empty or if * is empty if either one of the two intervals is empty or if
* they are disjoint. * they are disjoint.
@ -119,26 +119,26 @@
*/ */
// \{ // \{
/*! \function bool Interval::IsEmpty() const; /*! \function bool Interval::isEmpty() const;
* \Return \true if the interval is empty, else \false. * \Return \true if the interval is empty, else \false.
*/ */
/*! \function bool Interval::IsPonctual() const; /*! \function bool Interval::isPonctual() const;
* \Return \true if the interval is reduced to a value, else \false. * \Return \true if the interval is reduced to a value, else \false.
*/ */
/*! \function bool Interval::Contains(const Unit& v) const; /*! \function bool Interval::contains(const Unit& v) const;
* \Return \true if the interval is non empty and contains the value * \Return \true if the interval is non empty and contains the value
* defined by \c \<v\> else \false. * defined by \c \<v\> else \false.
*/ */
/*! \function bool Interval::Contains(const Interval& interval) const; /*! \function bool Interval::contains(const Interval& interval) const;
* \Return \true if the two intervals are non empty and if the interval * \Return \true if the two intervals are non empty and if the interval
* \c \<this\> contains the interval \c \<interval\>, else * \c \<this\> contains the interval \c \<interval\>, else
* \false. * \false.
*/ */
/*! \function bool Interval::Intersect(const Interval& interval) const; /*! \function bool Interval::intersect(const Interval& interval) const;
* \Return \true if the two intervals are non empty and if they overlap, * \Return \true if the two intervals are non empty and if they overlap,
* else \false. * else \false.
*/ */
@ -150,47 +150,47 @@
*/ */
// \{ // \{
/*! \function Interval& Interval::MakeEmpty(); /*! \function Interval& Interval::makeEmpty();
* Transforms the interval into an empty one. * Transforms the interval into an empty one.
*/ */
/*! \function Interval& Interval::Inflate(const Unit& dv); /*! \function Interval& Interval::inflate(const Unit& dv);
* Expands (or contracts) the interval, if not empty, in each * Expands (or contracts) the interval, if not empty, in each
* direction of the quantity \c \<dv\>. This quantity might be * direction of the quantity \c \<dv\>. This quantity might be
* negative enough to transform it into an empty interval. * negative enough to transform it into an empty interval.
*/ */
/*! \function Interval& Interval::Inflate(const Unit& dvMin, const Unit& dvMax); /*! \function Interval& Interval::inflate(const Unit& dvMin, const Unit& dvMax);
* Expands (or contracts) the interval, if not empty, on the * Expands (or contracts) the interval, if not empty, on the
* left of the quantity \c \<dvMin\> and on the right of the * left of the quantity \c \<dvMin\> and on the right of the
* quantity \c \<dvMax\>. Those quantities might be negative * quantity \c \<dvMax\>. Those quantities might be negative
* enough to transform it into an empty interval. * enough to transform it into an empty interval.
*/ */
/*! \function Interval& Interval::Merge(const Unit& v); /*! \function Interval& Interval::merge(const Unit& v);
* Expands the interval in order that it encloses the value * Expands the interval in order that it encloses the value
* defined \c \<v\>. If the interval was initially empty it * defined \c \<v\>. If the interval was initially empty it
* becomes reduced to the enclosed value. * becomes reduced to the enclosed value.
*/ */
/*! \function Interval& Interval::Merge(const Interval& interval); /*! \function Interval& Interval::merge(const Interval& interval);
* Expands the interval in order that it encloses, if not empty, * Expands the interval in order that it encloses, if not empty,
* the interval \c \<interval\>. If the interval \c \<this\> was * the interval \c \<interval\>. If the interval \c \<this\> was
* initially empty it becomes reduced to the enclosed interval. * initially empty it becomes reduced to the enclosed interval.
*/ */
/*! \function Interval& Interval::Intersection(const Unit& vMin, const Unit& vMax); /*! \function Interval& Interval::intersection(const Unit& vMin, const Unit& vMax);
* The interval becomes the intersection of itself and * The interval becomes the intersection of itself and
* <b>[vMin,vMax]</b>. * <b>[vMin,vMax]</b>.
*/ */
/*! \function Interval& Interval::Intersection(const Interval& interval); /*! \function Interval& Interval::intersection(const Interval& interval);
* The interval becomes the intersection of itself and * The interval becomes the intersection of itself and
* <b>interval</b>. * <b>interval</b>.
*/ */
/*! \function Interval& Interval::Translate(const Unit& dv); /*! \function Interval& Interval::translate(const Unit& dv);
* Translates the interval, if not empty, of the quantity * translates the interval, if not empty, of the quantity
* \c \<dv\>. * \c \<dv\>.
* *
* Exemple : * Exemple :
@ -198,7 +198,7 @@
Interval interval1 = Interval(10, 100); Interval interval1 = Interval(10, 100);
Interval interval2 = interval1; Interval interval2 = interval1;
assert(interval1.Translate(10) == interval2.Inflate(-10, 10)); assert(interval1.translate(10) == interval2.inflate(-10, 10));
\endcode \endcode
* *
* *

30
hurricane/doc/hurricane/Layer.dox
View File

@ -40,19 +40,19 @@
*/ */
// \{ // \{
/*! \function Technology* Layer::GetTechnology() const; /*! \function Technology* Layer::getTechnology() const;
* \Return the technolgy owning the layer. * \Return the technolgy owning the layer.
*/ */
/*! \function const Name& Layer::GetName() const; /*! \function const Name& Layer::getName() const;
* \Return the name of the layer. * \Return the name of the layer.
*/ */
/*! \function const Layer::Mask& Layer::GetMask() const; /*! \function const Layer::Mask& Layer::getMask() const;
* \Return the mask associated to the layer. * \Return the mask associated to the layer.
*/ */
/*! \function const Layer::Mask& Layer::GetExtractMask() const; /*! \function const Layer::Mask& Layer::getExtractMask() const;
* \Return the mask used for extraction. * \Return the mask used for extraction.
* *
* Two differents basic layers have different masks but may have * Two differents basic layers have different masks but may have
@ -60,16 +60,16 @@
* CPG which represent poly used to realize transistor gates). * CPG which represent poly used to realize transistor gates).
*/ */
/*! \function const Unit& Layer::GetMinimalSize() const; /*! \function const Unit& Layer::getMinimalSize() const;
* \Return the minimal size allowed for a rectangular layout pad on this * \Return the minimal size allowed for a rectangular layout pad on this
* layer. * layer.
*/ */
/*! \function const Unit& Layer::GetMinimalSpacing() const; /*! \function const Unit& Layer::getMinimalSpacing() const;
* \Return the minimal spacing between two pads on this layer. * \Return the minimal spacing between two pads on this layer.
*/ */
/*! \function BasicLayers Layer::GetBasicLayers() const; /*! \function BasicLayers Layer::getBasicLayers() const;
* \Return the collection of basic layers within this layer. * \Return the collection of basic layers within this layer.
* *
* \remark For a basic layer the collection contains this one only. * \remark For a basic layer the collection contains this one only.
@ -82,13 +82,13 @@
*/ */
// \{ // \{
/*! \function bool Layer::Contains(Layer* layer) const; /*! \function bool Layer::contains(const Layer* layer) const;
* \Return \true if the \c \<layer\> is completely included in the layer * \Return \true if the \c \<layer\> is completely included in the layer
* \c \<this\> (that is if the basic layers of \c \<layer\> are * \c \<this\> (that is if the basic layers of \c \<layer\> are
* a sub-set of the basic layers of \c \<this\>), else \false. * a sub-set of the basic layers of \c \<this\>), else \false.
*/ */
/*! \function bool Layer::Intersect(Layer* layer) const; /*! \function bool Layer::intersect(const Layer* layer) const;
* \Return \true if the \c \<layer\> and the layer \c \<this\> have at * \Return \true if the \c \<layer\> and the layer \c \<this\> have at
* least a common basic layer, else \false. * least a common basic layer, else \false.
*/ */
@ -100,19 +100,19 @@
*/ */
// \{ // \{
/*! \function void Layer::SetName(const Name& name); /*! \function void Layer::setName(const Name& name);
* Sets or changes the layer name. * sets or changes the layer name.
* *
* \remark An exception is thrown if the name is empty or if there is an * \remark An exception is thrown if the name is empty or if there is an
* other layer with that name. * other layer with that name.
*/ */
/*! \function void Layer::SetMinimalSize(const Unit& minimalSize); /*! \function void Layer::setMinimalSize(const Unit& minimalSize);
* Sets the minimal size of a pad on this layer. * sets the minimal size of a pad on this layer.
*/ */
/*! \function void Layer::SetMinimalSpacing(const Unit& minimalSpacing); /*! \function void Layer::setMinimalSpacing(const Unit& minimalSpacing);
* Sets the minimal spacing between two pads on this layer. * sets the minimal spacing between two pads on this layer.
*/ */
// \} // \}

28
hurricane/doc/hurricane/Library.dox
View File

@ -28,16 +28,16 @@
*/ */
// \{ // \{
/*! \function Library* Library::Create(DataBase* dataBase, const Name& name); /*! \function Library* Library::create(DataBase* dataBase, const Name& name);
* Creates and returns a new root library named \c \<name\> for * creates and returns a new root library named \c \<name\> for
* the data base \c \<dataBase\>. * the data base \c \<dataBase\>.
* *
* \caution Throws an exception if the data base is null, if the name is * \caution Throws an exception if the data base is null, if the name is
* empty or if the data base already contains a root library. * empty or if the data base already contains a root library.
*/ */
/*! \function Library* Library::Create(Library* library, const Name& name); /*! \function Library* Library::create(Library* library, const Name& name);
* Creates and returns a new sub library named \c \<name\> for * creates and returns a new sub library named \c \<name\> for
* the library \c \<library\>. * the library \c \<library\>.
* *
* \caution Throws an exception if the library is null, if the name is * \caution Throws an exception if the library is null, if the name is
@ -52,39 +52,39 @@
*/ */
// \{ // \{
/*! \function DataBase* Library::GetDataBase() const; /*! \function DataBase* Library::getDataBase() const;
* \Return the data base owning directly or indirectly the library. * \Return the data base owning directly or indirectly the library.
*/ */
/*! \function Library* Library::GetLibrary() const; /*! \function Library* Library::getLibrary() const;
* \Return the library owning the library (NULL for the root library). * \Return the library owning the library (NULL for the root library).
*/ */
/*! \function const Name& Library::GetName() const; /*! \function const Name& Library::getName() const;
* \Return the name of the library. * \Return the name of the library.
*/ */
/*! \function Library* Library::GetLibrary(const Name& name) const; /*! \function Library* Library::getLibrary(const Name& name) const;
* \Return the sub library of name \c \<name\> if it exists, else NULL. * \Return the sub library of name \c \<name\> if it exists, else NULL.
*/ */
/*! \function Libraries Library::GetLibraries() const; /*! \function Libraries Library::getLibraries() const;
* \Return the collection of all sub libraries of the library. * \Return the collection of all sub libraries of the library.
*/ */
/*! \function Cell* Library::GetCell(const Name& name) const; /*! \function Cell* Library::getCell(const Name& name) const;
* \Return the cell of name \c \<name\> if it exists, else NULL. * \Return the cell of name \c \<name\> if it exists, else NULL.
*/ */
/*! \function Cells Library::GetCells() const; /*! \function Cells Library::getCells() const;
* \Return the collection of all cells of the library. * \Return the collection of all cells of the library.
*/ */
/*! \function Symbol* Library::GetSymbol(const Name& name) const; /* \function Symbol* Library::getSymbol(const Name& name) const;
* \Return the symbol of name \c \<name\> if it exists, else NULL. * \Return the symbol of name \c \<name\> if it exists, else NULL.
*/ */
/*! \function Symbols Library::GetSymbols() const; /* \function Symbols Library::getSymbols() const;
* \Return the collection of all symbols of the library. * \Return the collection of all symbols of the library.
*/ */
@ -95,7 +95,7 @@
*/ */
// \{ // \{
/*! \function void Library::SetName(const Name& name); /*! \function void Library::setName(const Name& name);
* Allows to change the library name. * Allows to change the library name.
* *
* \remark Throws an exception if the new name is empty or if the * \remark Throws an exception if the new name is empty or if the

22
hurricane/doc/hurricane/Locator.dox
View File

@ -23,17 +23,17 @@
* existing locator allowing to visit the remaining elements * existing locator allowing to visit the remaining elements
* starting from the current position of that locator. * starting from the current position of that locator.
* *
* <b>End of walk indicator</b> The predicate <b>IsValid()</b> * <b>End of walk indicator</b> The predicate <b>isValid()</b>
* returns \true if the locator refers an element of the set, * returns \true if the locator refers an element of the set,
* \false when all the elements have been visited. * \false when all the elements have been visited.
* *
* <b>Getting the current element</b> The current element is * <b>getting the current element</b> The current element is
* obtained by the accessor <b>GetElement()</b>. There is no * obtained by the accessor <b>getElement()</b>. There is no
* risk to call this function when the visit is finished or the * risk to call this function when the visit is finished or the
* locator is non initialized (the returned value is * locator is non initialized (the returned value is
* meaningless). * meaningless).
* *
* <b>Walk progression</b> The function <b>Progress()</b> moves * <b>Walk progression</b> The function <b>progress()</b> moves
* forward the locator on the next element of the set (does * forward the locator on the next element of the set (does
* nothing if called after the last element). * nothing if called after the last element).
*/ */
@ -51,9 +51,9 @@ if (cell) {
// CellGetNets() // CellGetNets()
// returns the nets collection of the cell // returns the nets collection of the cell
// and GetLocator() // and getLocator()
// allocates and returns a locator for traversing those nets // allocates and returns a locator for traversing those nets
Locator<Net*>* locator = CellGetNets().GetLocator(); Locator<Net*>* locator = CellGetNets().getLocator();
while (locatorIsValid()) { while (locatorIsValid()) {
Net* net = locatorGetElement(); Net* net = locatorGetElement();
@ -70,7 +70,7 @@ if (cell) {
Cell* cell = ...; // we get a cell Cell* cell = ...; // we get a cell
if (cell) { if (cell) {
Locator<Net*>* locator1 = CellGetNets().GetLocator(); Locator<Net*>* locator1 = CellGetNets().getLocator();
while (locator1IsValid()) { while (locator1IsValid()) {
Net* net1 = locator1GetElement(); Net* net1 = locator1GetElement();
@ -99,12 +99,12 @@ if (cell) {
*/ */
// \{ // \{
/*! \function Type Locator::GetElement() const; /*! \function Type Locator::getElement() const;
* \Return the current element (or the value <b>Type()</b> when the * \Return the current element (or the value <b>Type()</b> when the
* locator is not or no longer valid). * locator is not or no longer valid).
*/ */
/*! \function Locator<Type>* Locator::GetClone() const; /*! \function Locator<Type>* Locator::getClone() const;
* This function allocates and returns a new locator that will * This function allocates and returns a new locator that will
* have the same visiting course than the remaining one of the * have the same visiting course than the remaining one of the
* locator being cloned. * locator being cloned.
@ -122,7 +122,7 @@ if (cell) {
*/ */
// \{ // \{
/*! \function bool Locator::IsValid() const; /*! \function bool Locator::isValid() const;
* \Return \true while the walk has not exhausted the set of elements, * \Return \true while the walk has not exhausted the set of elements,
* else \false. * else \false.
*/ */
@ -134,7 +134,7 @@ if (cell) {
*/ */
// \{ // \{
/*! \function void Locator::Progress(); /*! \function void Locator::progress();
* Moves forward the locator to the following element. * Moves forward the locator to the following element.
*/ */

2
hurricane/doc/hurricane/Name.dox
View File

@ -152,7 +152,7 @@ for_each_net(net, cellGetNets()) {
*/ */
// \{ // \{
/*! \function bool Name::IsEmpty () const; /*! \function bool Name::isEmpty () const;
* \Return \true if the shared string is empty, else \false. * \Return \true if the shared string is empty, else \false.
*/ */

32
hurricane/doc/hurricane/Occurrence.dox
View File

@ -127,37 +127,37 @@
*/ */
// \{ // \{
/*! \function Entity* Occurrence::GetEntity() const; /*! \function Entity* Occurrence::getEntity() const;
* \Return the referenced entity or NULL if the occurrence is invalid. * \Return the referenced entity or NULL if the occurrence is invalid.
*/ */
/*! \function const Path& Occurrence::GetPath() const; /*! \function const Path& Occurrence::getPath() const;
* \Return the hierarchical instanciation path of the occurrence * \Return the hierarchical instanciation path of the occurrence
* (possibly void, but always void when the occurrence id * (possibly void, but always void when the occurrence id
* invalid). * invalid).
*/ */
/*! \function Cell* Occurrence::GetOwnerCell() const; /*! \function Cell* Occurrence::getOwnerCell() const;
* \Return the owner cell of the occurrence or NULL if the occurrence is * \Return the owner cell of the occurrence or NULL if the occurrence is
* invalid. * invalid.
*/ */
/*! \function Cell* Occurrence::GetMasterCell() const; /*! \function Cell* Occurrence::getMasterCell() const;
* \Return the cell owning the referenced entity or NULL if the * \Return the cell owning the referenced entity or NULL if the
* occurrence is invalid. * occurrence is invalid.
*/ */
/*! \function Property* Occurrence::GetProperty(const Name& name) const; /*! \function Property* Occurrence::getProperty(const Name& name) const;
* \Return the property named \c \<name\> if it exists or NULL if not * \Return the property named \c \<name\> if it exists or NULL if not
* (or if the occurrence is invalid). * (or if the occurrence is invalid).
*/ */
/*! \function Properties Occurrence::GetProperties() const; /*! \function Properties Occurrence::getProperties() const;
* \Return the collection of properties attached to the occurrence * \Return the collection of properties attached to the occurrence
* (always empty if the occurrence is invalid). * (always empty if the occurrence is invalid).
*/ */
/*! \function Box Occurrence::GetBoundingBox() const; /*! \function Box Occurrence::getBoundingBox() const;
* \Return the bounding box of the occurrence (within the coordinate * \Return the bounding box of the occurrence (within the coordinate
* sysem of the owner cell) if it is valid or else the empty * sysem of the owner cell) if it is valid or else the empty
* box. * box.
@ -170,12 +170,12 @@
*/ */
// \{ // \{
/*! \function bool Occurrence::IsValid() const; /*! \function bool Occurrence::isValid() const;
* \Return \true if the occurrence is valid, else \false (the occurrence * \Return \true if the occurrence is valid, else \false (the occurrence
* refers no entity). * refers no entity).
*/ */
/*! \function bool Occurrence::HasProperty() const; /*! \function bool Occurrence::hasProperty() const;
* \Return \true if the occurrence owns some property else \false. * \Return \true if the occurrence owns some property else \false.
*/ */
@ -186,7 +186,7 @@
*/ */
// \{ // \{
/*! \function void Occurrence::Put(Property* property); /*! \function void Occurrence::put(Property* property);
* Adds the property \c \<property\> to the occurrence property * Adds the property \c \<property\> to the occurrence property
* set. The property being named, if another property already * set. The property being named, if another property already
* exists in the set it will be, in a first step, detached from * exists in the set it will be, in a first step, detached from
@ -199,8 +199,8 @@
* exception is thrown. * exception is thrown.
*/ */
/*! \function void Occurrence::Remove(Property* property); /*! \function void Occurrence::remove(Property* property);
* Removes the property \c \<property\> from the occurrence * removes the property \c \<property\> from the occurrence
* property set. * property set.
* *
* \remark Does nothing if the occurrence doesn't own this property * \remark Does nothing if the occurrence doesn't own this property
@ -210,14 +210,14 @@
* exception is thrown. * exception is thrown.
*/ */
/*! \function void Occurrence::RemoveProperty(const Name& name); /*! \function void Occurrence::removeProperty(const Name& name);
* Removes the property of name \c \<name\> if it exists. * removes the property of name \c \<name\> if it exists.
* *
* \caution If the occurrence is invalid an exception is thrown. * \caution If the occurrence is invalid an exception is thrown.
*/ */
/*! \function void Occurrence::ClearProperties(); /*! \function void Occurrence::clearProperties();
* Removes all properties attached to the occurrence. As a * removes all properties attached to the occurrence. As a
* consequence, the occurrence is deleted. * consequence, the occurrence is deleted.
* *
* \caution If the occurrence is invalid an exception is thrown. * \caution If the occurrence is invalid an exception is thrown.

2
hurricane/doc/hurricane/Pad.dox
View File

@ -23,7 +23,7 @@
*/ */
// \{ // \{
/*! \function Pad* Pad::Create(Net* net, Layer* layer, const Box& boundingBox); /*! \function Pad* Pad::create(Net* net, Layer* layer, const Box& boundingBox);
* No description. * No description.
*/ */

28
hurricane/doc/hurricane/Path.dox
View File

@ -83,7 +83,7 @@
* names described as a character string. Each instance name is * names described as a character string. Each instance name is
* separated from the preceeding one by a special delimiter * separated from the preceeding one by a special delimiter
* (which can be defined with the function * (which can be defined with the function
* <b>SetPathNameSeparator</b> to be defined later). The cell * <b>setPathNameSeparator</b> to be defined later). The cell
* given in argument defines where sarts the search (at each new * given in argument defines where sarts the search (at each new
* instance identified, we go to its model cell to pursue the * instance identified, we go to its model cell to pursue the
* search within the \c \<pathName\>). * search within the \c \<pathName\>).
@ -143,47 +143,47 @@
*/ */
// \{ // \{
/*! \function Instance* Path::GetHeadInstance() const; /*! \function Instance* Path::getHeadInstance() const;
* \Return the head instance or NULL if the path is void. * \Return the head instance or NULL if the path is void.
*/ */
/*! \function Path Path::GetTailPath() const; /*! \function Path Path::getTailPath() const;
* \Return the tail path or a void path if the path has 1 or 0 * \Return the tail path or a void path if the path has 1 or 0
* hierarchical depth. * hierarchical depth.
*/ */
/*! \function Path Path::GetHeadPath() const; /*! \function Path Path::getHeadPath() const;
* \Return the head path or a void path if the path has 1 or 0 * \Return the head path or a void path if the path has 1 or 0
* hierarchical depth. * hierarchical depth.
*/ */
/*! \function Instance* Path::GetTailInstance() const; /*! \function Instance* Path::getTailInstance() const;
* \Return the tail instance or NULL if the path is void. * \Return the tail instance or NULL if the path is void.
*/ */
/*! \function string Path::GetName() const; /*! \function string Path::getName() const;
* \Return a string defined by the concatenation of instance names * \Return a string defined by the concatenation of instance names
* separated by a special character (which can be set up by the * separated by a special character (which can be set up by the
* function <b>SetPathNameSeparator</b>). * function <b>setPathNameSeparator</b>).
* *
* \Return the string <b>""</b> when the path is void. * \Return the string <b>""</b> when the path is void.
*/ */
/*! \function Cell* Path::GetOwnerCell() const; /*! \function Cell* Path::getOwnerCell() const;
* Retruns the cell owning the head instance or NULL if the path * Retruns the cell owning the head instance or NULL if the path
* is void. * is void.
*/ */
/*! \function Cell* Path::GetMasterCell() const; /*! \function Cell* Path::getMasterCell() const;
* \Return the master cell referenced by the last instance of the path * \Return the master cell referenced by the last instance of the path
* or NULL if the path is void. * or NULL if the path is void.
*/ */
/*! \function Instances Path::GetInstances() const; /*! \function Instances Path::getInstances() const;
* \Return the collection of instances defining the path. * \Return the collection of instances defining the path.
*/ */
/*! \function Transformation Path::GetTransformation(const Transformation& transformation = Transformation()) const; /*! \function Transformation Path::getTransformation(const Transformation& transformation = Transformation()) const;
* \Return the transform resulting of the composition of all transforms * \Return the transform resulting of the composition of all transforms
* associated with the different instances of the path, applied * associated with the different instances of the path, applied
* to the given \c \<transformation\>. * to the given \c \<transformation\>.
@ -196,7 +196,7 @@
*/ */
// \{ // \{
/*! \function bool Path::IsEmpty() const; /*! \function bool Path::isEmpty() const;
* \Return \true if the path is void and else \false. * \Return \true if the path is void and else \false.
*/ */
@ -207,12 +207,12 @@
*/ */
// \{ // \{
/*! \function char Path::GetNameSeparator(); /*! \function char Path::getNameSeparator();
* \Return the special character used as a separator between the * \Return the special character used as a separator between the
* instance names of a path. By default it is the '.' (point). * instance names of a path. By default it is the '.' (point).
*/ */
/*! \function void Path::SetNameSeparator(char separator); /*! \function void Path::setNameSeparator(char separator);
* This function sets the special character used as a separator * This function sets the special character used as a separator
* between the instance names of a path (choose it carrefully, * between the instance names of a path (choose it carrefully,
* it must not appear in any instance name). * it must not appear in any instance name).

20
hurricane/doc/hurricane/Plug.dox
View File

@ -37,8 +37,8 @@
* \section secPlugPredefinedFilters Predefined filters * \section secPlugPredefinedFilters Predefined filters
* *
* *
* <b>Hurricane::Plug::GetIsConnectedFilter</b> * <b>Hurricane::Plug::getIsConnectedFilter</b>
* <b>Hurricane::Plug::GetIsUnconnectedFilter</b> * <b>Hurricane::Plug::getIsUnconnectedFilter</b>
*/ */
@ -53,15 +53,15 @@
*/ */
// \{ // \{
/*! \function Instance* Plug::GetInstance() const; /*! \function Instance* Plug::getInstance() const;
* \Return the instance to which belongs the plug. * \Return the instance to which belongs the plug.
*/ */
/*! \function Net* Plug::GetMasterNet() const; /*! \function Net* Plug::getMasterNet() const;
* \Return the external net referenced by the plug in the master cell of * \Return the external net referenced by the plug in the master cell of
* its instance. * its instance.
* *
* \remark Don't mistake with GetNet() which returns the net owning the * \remark Don't mistake with getNet() which returns the net owning the
* plug (or NULL if is unconnected). * plug (or NULL if is unconnected).
*/ */
@ -72,10 +72,10 @@
*/ */
// \{ // \{
/*! \function bool Plug::IsConnected() const; /*! \function bool Plug::isConnected() const;
* \Return \true if the plug is connected, else \false. * \Return \true if the plug is connected, else \false.
* *
* \remark A plug is connected if the call upon <b>GetNet()</b> doesn't * \remark A plug is connected if the call upon <b>getNet()</b> doesn't
* return NULL. * return NULL.
*/ */
@ -86,7 +86,7 @@
*/ */
// \{ // \{
/*! \function void Plug::SetNet(Net* net); /*! \function void Plug::setNet(Net* net);
* This method allows to connect or change the net of a plug. * This method allows to connect or change the net of a plug.
* *
* \caution An exception is thrown if the net owner cell differs from the * \caution An exception is thrown if the net owner cell differs from the
@ -129,11 +129,11 @@
*/ */
// \{ // \{
/*! \function PlugFilter Plug::GetIsConnectedFilter(); /*! \function PlugFilter Plug::getIsConnectedFilter();
* \Return a filter for selecting only connected plugs. * \Return a filter for selecting only connected plugs.
*/ */
/*! \function PlugFilter Plug::GetIsUnconnectedFilter(); /*! \function PlugFilter Plug::getIsUnconnectedFilter();
* \Return a filter for selecting only unconnected plugs. * \Return a filter for selecting only unconnected plugs.
*/ */

6
hurricane/doc/hurricane/Point.dox
View File

@ -52,15 +52,15 @@
*/ */
// \{ // \{
/*! \function void Point::SetX(const Unit& x); /*! \function void Point::setX(const Unit& x);
* Modifies point abscissa. * Modifies point abscissa.
*/ */
/*! \function void Point::SetY(const Unit& y); /*! \function void Point::setY(const Unit& y);
* Modifies point ordinate. * Modifies point ordinate.
*/ */
/*! \function Point& Point::Translate(const Unit& dx, const Unit& dy); /*! \function Point& Point::translate(const Unit& dx, const Unit& dy);
* Translates the point of dx and dy. * Translates the point of dx and dy.
*/ */

50
hurricane/doc/hurricane/Property.dox
View File

@ -46,7 +46,7 @@
* they are subtypes of data base object and therefore can store * they are subtypes of data base object and therefore can store
* the properties attached to occurences. * the properties attached to occurences.
* *
* \important Only one quark is attached to all occurences which refer the * \important only one quark is attached to all occurences which refer the
* same entity of the virtually unfolded hierarchy. This means * same entity of the virtually unfolded hierarchy. This means
* that a property placed on an occurence can be read by any * that a property placed on an occurence can be read by any
* other occurence which refers the same entity of the virtually * other occurence which refers the same entity of the virtually
@ -66,12 +66,12 @@
* *
* <b>Accessing a property by its name</b> * <b>Accessing a property by its name</b>
\code \code
Property* DBo::GetProperty(const Name& name) const; Property* DBo::getProperty(const Name& name) const;
\endcode \endcode
* This member function returns the property of name \c \<name\> * This member function returns the property of name \c \<name\>
* if there is one attached to the object, else NULL. * if there is one attached to the object, else NULL.
\code \code
Property* Occurrence::GetProperty(const Name& name) const; Property* Occurrence::getProperty(const Name& name) const;
\endcode \endcode
* This function searches in a first time the quark representing * This function searches in a first time the quark representing
* the occurence. * the occurence.
@ -86,12 +86,12 @@ Property* Occurrence::GetProperty(const Name& name) const;
* *
* <b>Accessing the set of all properties</b> * <b>Accessing the set of all properties</b>
\code \code
Properties DBo::GetProperties() const; Properties DBo::getProperties() const;
\endcode \endcode
* Return the collection of properties attached to the object (possibly * Return the collection of properties attached to the object (possibly
* empty). * empty).
\code \code
Properties Occurrence::GetProperties() const; Properties Occurrence::getProperties() const;
\endcode \endcode
* This function searches in a first time the quark representing * This function searches in a first time the quark representing
* the occurence. * the occurence.
@ -135,7 +135,7 @@ void Occurence::Put(Property* property);
* If the quark doesn't exist it is automatically created in * If the quark doesn't exist it is automatically created in
* order to attach this first property. * order to attach this first property.
* *
* Once the quark has been got or created, we can add the * once the quark has been got or created, we can add the
* property with the previous function. * property with the previous function.
* *
* Two important things might happen then : The property is * Two important things might happen then : The property is
@ -152,8 +152,8 @@ void Occurence::Put(Property* property);
* destroy the property which has been detached ? There is no * destroy the property which has been detached ? There is no
* unique behaviour which matches all needs. In order to solve * unique behaviour which matches all needs. In order to solve
* this problem the properties must answer to two specific * this problem the properties must answer to two specific
* messages which are : <b>OnCapturedBy(DBo* dbo)</b> when the * messages which are : <b>onCapturedBy(DBo* dbo)</b> when the
* property is attached to an object and <b>OnReleasedBy(DBo* * property is attached to an object and <b>onReleasedBy(DBo*
* dbo)</b> when it is detached from the object. It is within * dbo)</b> when it is detached from the object. It is within
* that last message that the decision about the future of the * that last message that the decision about the future of the
* property must be taken. * property must be taken.
@ -181,7 +181,7 @@ void Occurence::Remove(Property* property);
* by calling the previous function. Furthermore if this removed * by calling the previous function. Furthermore if this removed
* property is the last one, the quark is automatically deleted. * property is the last one, the quark is automatically deleted.
* *
* \important The message <b>OnReleasedBy</b> is called upon as explained * \important The message <b>onReleasedBy</b> is called upon as explained
* above. This call will decide of the future of the removed * above. This call will decide of the future of the removed
* property. * property.
* *
@ -201,7 +201,7 @@ void Occurence::ClearProperties();
* properties (wich may lead to their removal). Without quark * properties (wich may lead to their removal). Without quark
* the occurence looses all its properties. * the occurence looses all its properties.
* *
* \important Here again the message <b>OnReleasedBy</b> is called upon for * \important Here again the message <b>onReleasedBy</b> is called upon for
* each removed property. * each removed property.
* *
* *
@ -215,7 +215,7 @@ void Occurence::ClearProperties();
* *
* \section secPropertyDeletionProcess Deletion process * \section secPropertyDeletionProcess Deletion process
* *
* <b>Hurricane::Property::Delete</b> * <b>Hurricane::Property::destroy</b>
* *
* *
* \section secPropertyNaming Naming Conventions * \section secPropertyNaming Naming Conventions
@ -248,7 +248,7 @@ void Occurence::ClearProperties();
* collected property is of the expected type, as shown in the * collected property is of the expected type, as shown in the
* following example : * following example :
\code \code
Property* property = occurence.GetProperty("Hurricane::Selector"); Property* property = occurence.getProperty("Hurricane::Selector");
if (property && is_a<Selector*>(property)) { if (property && is_a<Selector*>(property)) {
Selector* selector = (Selector*)property; Selector* selector = (Selector*)property;
@ -257,7 +257,7 @@ if (property && is_a<Selector*>(property)) {
\endcode \endcode
* Which could become : * Which could become :
\code \code
Selector* selector = (Selector*)occurence.GetProperty("Hurricane::Selector"); Selector* selector = (Selector*)occurence.getProperty("Hurricane::Selector");
if (selector) { if (selector) {
... ...
@ -272,7 +272,7 @@ if (selector) {
* pointers and not on their character strings. The length of * pointers and not on their character strings. The length of
* the name doesn't affect the comparison performance. * the name doesn't affect the comparison performance.
* *
* On the other hand, the time to create a property name depends * on the other hand, the time to create a property name depends
* obviously of its length and of the number of names (which * obviously of its length and of the number of names (which
* fortunately are managed by efficient map containers). * fortunately are managed by efficient map containers).
* *
@ -283,15 +283,15 @@ if (selector) {
* As a matter of fact if you write, like in the previous * As a matter of fact if you write, like in the previous
* example : * example :
\code \code
Property* property = occurence.GetProperty("Hurricane::Selector"); Property* property = occurence.getProperty("Hurricane::Selector");
\endcode \endcode
* Each time the name is built and this will degrade * Each time the name is built and this will degrade
* performance. * performance.
* *
* On the other hand if the following static member function is * on the other hand if the following static member function is
* provided : * provided :
\code \code
const Name& Selector::GetPropertyName() const Name& Selector::getPropertyName()
// ************************************ // ************************************
{ {
static Name NAME = "Hurricane::Selector"; static Name NAME = "Hurricane::Selector";
@ -300,7 +300,7 @@ const Name& Selector::GetPropertyName()
\endcode \endcode
* You could write later : * You could write later :
\code \code
Property* property = occurence.GetProperty(Selector::GetPropertyName()); Property* property = occurence.getProperty(Selector::getPropertyName());
\endcode \endcode
* This approach is much more efficient and presents an other * This approach is much more efficient and presents an other
* interest : you don't need to know the name of the property * interest : you don't need to know the name of the property
@ -324,7 +324,7 @@ Property* property = occurence.GetProperty(Selector::GetPropertyName());
* That way, by defining (i.e. for the property ObjectId) the * That way, by defining (i.e. for the property ObjectId) the
* function : * function :
\code \code
const Name& GetObjectIdPropertyName() const Name& getObjectIdPropertyName()
// ********************************** // **********************************
{ {
static Name NAME = "Hurricane::ObjectId"; static Name NAME = "Hurricane::ObjectId";
@ -333,7 +333,7 @@ const Name& GetObjectIdPropertyName()
\endcode \endcode
* You can write later : * You can write later :
\code \code
Property* property = occurence.GetProperty(GetObjectIdPropertyName()); Property* property = occurence.getProperty(getObjectIdPropertyName());
\endcode \endcode
*/ */
@ -342,7 +342,7 @@ Property* property = occurence.GetProperty(GetObjectIdPropertyName());
*/ */
// \{ // \{
/*! \function Name Property::GetName() const; /*! \function Name Property::getName() const;
* \Return the name of the property : this method must absolutely be * \Return the name of the property : this method must absolutely be
* overloaded for all new property classes, because the property * overloaded for all new property classes, because the property
* name is not a "wired in" attribute. A property being a real * name is not a "wired in" attribute. A property being a real
@ -358,7 +358,7 @@ Property* property = occurence.GetProperty(GetObjectIdPropertyName());
*/ */
// \{ // \{
/*! \function void Property::OnCapturedBy(DBo* dbo); /*! \function void Property::onCapturedBy(DBo* dbo);
* This message is called upon when the property is added to the * This message is called upon when the property is added to the
* properties of \c \<dbo\>. * properties of \c \<dbo\>.
* *
@ -372,7 +372,7 @@ Property* property = occurence.GetProperty(GetObjectIdPropertyName());
* specializing any of those two classes. * specializing any of those two classes.
*/ */
/*! \function void Property::OnReleasedBy(DBo* dbo); /*! \function void Property::onReleasedBy(DBo* dbo);
* This message is called upon when the property is removed from * This message is called upon when the property is removed from
* the \c \<dbo\> properties. * the \c \<dbo\> properties.
* *
@ -413,7 +413,7 @@ Property* property = occurence.GetProperty(GetObjectIdPropertyName());
\code \code
Occurence occurence = ...; // we get an occurence Occurence occurence = ...; // we get an occurence
for_each_property(property, occurence.GetProperties()) { for_each_property(property, occurence.getProperties()) {
cerr << property << endl; cerr << property << endl;
end_for; end_for;
} }
@ -427,7 +427,7 @@ for_each_property(property, occurence.GetProperties()) {
*/ */
// \{ // \{
/*! \function void Property::Delete(); /*! \function void Property::destroy();
* Like the data base objects, properties can be destroyed by * Like the data base objects, properties can be destroyed by
* calling upon this function and not the standard C++ * calling upon this function and not the standard C++
* destructor (which is not available). * destructor (which is not available).

32
hurricane/doc/hurricane/QuadTree.dox
View File

@ -51,18 +51,18 @@
*/ */
// \{ // \{
/*! \function Box QuadTree::GetBoundingBox() const; /*! \function Box QuadTree::getBoundingBox() const;
* \Return the quadtree bounding box, that is the minimal bounding box * \Return the quadtree bounding box, that is the minimal bounding box
* including all objects of the quad tree (this bounding box is * including all objects of the quad tree (this bounding box is
* updated dynamically). * updated dynamically).
*/ */
/*! \function Gos QuadTree::GetGos() const; /*! \function Gos QuadTree::getGos() const;
* \Return the collection of graphical objects contained in the * \Return the collection of graphical objects contained in the
* quadtree. * quadtree.
*/ */
/*! \function Gos QuadTree::GetGosUnder(const Box& area) const; /*! \function Gos QuadTree::getGosUnder(const Box& area) const;
* \Return the collection of graphical objects contained in the quadtree * \Return the collection of graphical objects contained in the quadtree
* and whose bounding box intersects the rectangular region * and whose bounding box intersects the rectangular region
* defined by \c \<area\>. * defined by \c \<area\>.
@ -75,7 +75,7 @@
*/ */
// \{ // \{
/*! \function bool QuadTree::IsEmpty() const; /*! \function bool QuadTree::isEmpty() const;
* \Return <b>true</b> if the quadtree doesn't contain any object, else * \Return <b>true</b> if the quadtree doesn't contain any object, else
* <b>false</b>. * <b>false</b>.
*/ */
@ -87,8 +87,8 @@
*/ */
// \{ // \{
/*! \function void QuadTree::Insert(Go* go); /*! \function void QuadTree::insert(Go* go);
* Inserts the graphic object within the quadtree (if not yet * inserts the graphic object within the quadtree (if not yet
* inserted). * inserted).
* *
* \caution If the graphic object pointer is NULL an exception is thrown. * \caution If the graphic object pointer is NULL an exception is thrown.
@ -100,8 +100,8 @@
* of some memory loss). * of some memory loss).
*/ */
/*! \function void QuadTree::Remove(Go* go); /*! \function void QuadTree::remove(Go* go);
* Removes the object from the quadtree. * removes the object from the quadtree.
* *
* \caution If the graphic object is NULL an exception is thrown. * \caution If the graphic object is NULL an exception is thrown.
* *
@ -132,8 +132,8 @@ void Component::Materialize()
// ************************** // **************************
{ {
// we get the cell and the layer of the component // we get the cell and the layer of the component
Cell* cell = GetCell(); Cell* cell = getCell();
Layer* layer = GetLayer(); Layer* layer = getLayer();
// we get the slice within which the object must be inserted // we get the slice within which the object must be inserted
// (if necessary we create it) // (if necessary we create it)
@ -141,7 +141,7 @@ void Component::Materialize()
if (!slice) slice = Slice::_Create(cell, layer); if (!slice) slice = Slice::_Create(cell, layer);
// we get the quadtree associated to the slice // we get the quadtree associated to the slice
QuadTree* quadTree = slice_GetQuadTree(); QuadTree* quadTree = slice_getQuadTree();
// we insert into the object // we insert into the object
quadTreeInsert(this); quadTreeInsert(this);
@ -157,8 +157,8 @@ void Component::Unmaterialize()
// **************************** // ****************************
{ {
// we get the cell and the layer of the component // we get the cell and the layer of the component
Cell* cell = GetCell(); Cell* cell = getCell();
Layer* layer = GetLayer(); Layer* layer = getLayer();
// we get the associated slice // we get the associated slice
Slice* slice = cellGetSlice(layer); Slice* slice = cellGetSlice(layer);
@ -170,13 +170,13 @@ void Component::Unmaterialize()
// we inform the cell that an object with a given bounding // we inform the cell that an object with a given bounding
// box will be removed (does something only if the bounding // box will be removed (does something only if the bounding
// box is tangent to the cell bounding box) // box is tangent to the cell bounding box)
cell_Unfit(GetBoundingBox()); cell_Unfit(getBoundingBox());
\endcode \endcode
* // we remove the object from its slice * // we remove the object from its slice
* slice-\>_GetQuadTree()-\>Remove(this); * slice-\>_getQuadTree()-\>remove(this);
* *
* // if the slice becomes empty, it is destroyed if * // if the slice becomes empty, it is destroyed if
* (slice-\>IsEmpty()) slice-\>_Delete(); } } * (slice-\>isEmpty()) slice-\>_Delete(); } }
*/ */

6
hurricane/doc/hurricane/Quark.dox
View File

@ -63,11 +63,11 @@
Property* property = ...; // we get a property Property* property = ...; // we get a property
if (is_a<SharedPropery*>(property)) { if (is_a<SharedPropery*>(property)) {
for_each_dbo(dbo, ((SharedProperty*)property)GetOwners()) { for_each_dbo(dbo, ((SharedProperty*)property)getOwners()) {
if (!is_a<Quark*>(dbo)) if (!is_a<Quark*>(dbo))
cerr << dbo << endl; cerr << dbo << endl;
else else
cerr << ((Quark*)dbo)GetOccurence() << endl; cerr << ((Quark*)dbo)getOccurence() << endl;
end_for; end_for;
} }
} }
@ -80,7 +80,7 @@ if (is_a<SharedPropery*>(property)) {
*/ */
// \{ // \{
/*! \function const Occurrence& Quark::GetOccurrence() const; /*! \function const Occurrence& Quark::getOccurrence() const;
* \Return an occurence of which this quark is a representative. * \Return an occurence of which this quark is a representative.
*/ */

10
hurricane/doc/hurricane/Rubber.dox
View File

@ -31,16 +31,16 @@
*/ */
// \{ // \{
/*! \function Net* Rubber::GetNet() const; /*! \function Net* Rubber::getNet() const;
* \Return the net owning the rubber. * \Return the net owning the rubber.
*/ */
/*! \function Hook* Rubber::GetHook() const; /*! \function Hook* Rubber::getHook() const;
* \Return one hook (necessarily a master hook) of the ring which has * \Return one hook (necessarily a master hook) of the ring which has
* created the rubber. * created the rubber.
*/ */
/*! \function unsigned Rubber::GetCount() const; /*! \function unsigned Rubber::getCount() const;
* \Return the count associated to the rubber (in fact the number of * \Return the count associated to the rubber (in fact the number of
* master hooks of the ring). * master hooks of the ring).
* *
@ -48,11 +48,11 @@
* exists (no need). * exists (no need).
*/ */
/*! \function Point Rubber::GetCenter() const; /*! \function Point Rubber::getCenter() const;
* \Return the center of the rubber (computed at the fly). * \Return the center of the rubber (computed at the fly).
*/ */
/*! \function Hooks Rubber::GetHooks() const; /*! \function Hooks Rubber::getHooks() const;
* \Return the collection of master hooks that the rubber virtualy * \Return the collection of master hooks that the rubber virtualy
* connect. * connect.
*/ */

44
hurricane/doc/hurricane/Segment.dox
View File

@ -41,17 +41,17 @@
*/ */
// \{ // \{
/*! \function Segment::SourceHook* Segment::GetSourceHook(); /*! \function Segment::SourceHook* Segment::getSourceHook();
* \Return the hook through which the segment origin can be anchored on * \Return the hook through which the segment origin can be anchored on
* a component. * a component.
*/ */
/*! \function Segment::TargetHook* Segment::GetTargetHook(); /*! \function Segment::TargetHook* Segment::getTargetHook();
* \Return the hook through which the segment extremity can be anchored * \Return the hook through which the segment extremity can be anchored
* on a component. * on a component.
*/ */
/*! \function Hook* Segment::GetOppositeHook(const Hook* hook) const; /*! \function Hook* Segment::getOppositeHook(const Hook* hook) const;
* \Return the target hook of the segment if \c \<hook\> is the source * \Return the target hook of the segment if \c \<hook\> is the source
* hook of the segment. * hook of the segment.
* *
@ -61,7 +61,7 @@
* \Return NULL otherwise. * \Return NULL otherwise.
*/ */
/*! \function Component* Segment::GetSource() const; /*! \function Component* Segment::getSource() const;
* The source hook being a slave one, it may have an associated * The source hook being a slave one, it may have an associated
* master hook representing the body of the component on wich * master hook representing the body of the component on wich
* the segment origin is anchored. * the segment origin is anchored.
@ -70,7 +70,7 @@
* hook, if any, else a NULL pointer. * hook, if any, else a NULL pointer.
*/ */
/*! \function Component* Segment::GetTarget() const; /*! \function Component* Segment::getTarget() const;
* The target hook being a slave one, it may have an associated * The target hook being a slave one, it may have an associated
* master hook representing the body of the component on wich * master hook representing the body of the component on wich
* the segment extremity is anchored. * the segment extremity is anchored.
@ -79,7 +79,7 @@
* hook, if any, else a NULL pointer. * hook, if any, else a NULL pointer.
*/ */
/*! \function Component* Segment::GetOppositeAnchor(Component* anchor) const; /*! \function Component* Segment::getOppositeAnchor(Component* anchor) const;
* \Return the target anchor of the segment if \c \<anchor\> is the * \Return the target anchor of the segment if \c \<anchor\> is the
* source anchor of the segment (may be NULL) * source anchor of the segment (may be NULL)
* *
@ -89,46 +89,46 @@
* \Return NULL otherwise. * \Return NULL otherwise.
*/ */
/*! \function Components Segment::GetAnchors() const; /*! \function Components Segment::getAnchors() const;
* \Return the collection of anchors. This collection is composed by the * \Return the collection of anchors. This collection is composed by the
* source (if non NULL) and the target (if non NULL) of the * source (if non NULL) and the target (if non NULL) of the
* segment (may be empty if all extremities of the segment * segment (may be empty if all extremities of the segment
* aren't anchored). * aren't anchored).
*/ */
/*! \function const Unit& Segment::GetWidth() const; /*! \function const Unit& Segment::getWidth() const;
* \Return the segment width. * \Return the segment width.
*/ */
/*! \function Unit Segment::GetHalfWidth() const; /*! \function Unit Segment::getHalfWidth() const;
* \Return the segment half width. * \Return the segment half width.
*/ */
/*! \function Unit Segment::GetSourceX() const; /*! \function Unit Segment::getSourceX() const;
* \Return the abscissa of the segment origin. * \Return the abscissa of the segment origin.
*/ */
/*! \function Unit Segment::GetSourceY() const; /*! \function Unit Segment::getSourceY() const;
* \Return the ordinate of the segment origin. * \Return the ordinate of the segment origin.
*/ */
/*! \function Point Segment::GetSourcePosition() const; /*! \function Point Segment::getSourcePosition() const;
* \Return the point location of the segment origin. * \Return the point location of the segment origin.
*/ */
/*! \function Unit Segment::GetTargetX() const; /*! \function Unit Segment::getTargetX() const;
* \Return the abscissa of the segment extremity. * \Return the abscissa of the segment extremity.
*/ */
/*! \function Unit Segment::GetTargetY() const; /*! \function Unit Segment::getTargetY() const;
* \Return the ordinate of the segment extremity. * \Return the ordinate of the segment extremity.
*/ */
/*! \function Point Segment::GetTargetPosition() const; /*! \function Point Segment::getTargetPosition() const;
* \Return the point location of the segment extremity. * \Return the point location of the segment extremity.
*/ */
/*! \function Unit Segment::GetLength() const; /*! \function Unit Segment::getLength() const;
* \Return the segment length. * \Return the segment length.
*/ */
@ -139,16 +139,16 @@
*/ */
// \{ // \{
/*! \function void Segment::SetLayer(Layer* layer); /*! \function void Segment::setLayer(Layer* layer);
* Sets the segment layer. * sets the segment layer.
*/ */
/*! \function void Segment::SetWidth(const Unit& width); /*! \function void Segment::setWidth(const Unit& width);
* Sets the segment width. * sets the segment width.
*/ */
/*! \function void Segment::Invert(); /*! \function void Segment::invert();
* Invert the segment. The source and target of the segment are * invert the segment. The source and target of the segment are
* permutted. * permutted.
*/ */

18
hurricane/doc/hurricane/Slice.dox
View File

@ -39,9 +39,9 @@ BasicLayer* basicLayer = ...; // we get the basic layer
Box area = ...; // we define the rectangular area Box area = ...; // we define the rectangular area
for_each_slice(slice, cell->GetSlices()) { for_each_slice(slice, cell->getSlices()) {
if (slice->GetLayer()->Contains(basicLayer)) { if (slice->getLayer()->Contains(basicLayer)) {
for_each_componant(component, slice->GetComponentsUnder(area)) { for_each_componant(component, slice->getComponentsUnder(area)) {
... ...
// here we visit all requested components // here we visit all requested components
... ...
@ -59,29 +59,29 @@ for_each_slice(slice, cell->GetSlices()) {
*/ */
// \{ // \{
/*! \function Cell* Slice::GetCell() const; /*! \function Cell* Slice::getCell() const;
* \Return the cell owning the slice. * \Return the cell owning the slice.
*/ */
/*! \function Layer* Slice::GetLayer() const; /*! \function Layer* Slice::getLayer() const;
* \Return the layer associated to the slice : all components lying in a * \Return the layer associated to the slice : all components lying in a
* cell are perforce located on that layer. * cell are perforce located on that layer.
*/ */
/*! \function Box Slice::GetBoundingBox() const; /*! \function Box Slice::getBoundingBox() const;
* \Return the bounding box of the slice, that is the smallest enclosing * \Return the bounding box of the slice, that is the smallest enclosing
* rectangle of all its components. * rectangle of all its components.
*/ */
/*! \function const Gos Slice::GetGos() const; /*! \function const Gos Slice::getGos() const;
* \Return the collection of graphic objects lying on the slice. * \Return the collection of graphic objects lying on the slice.
*/ */
/*! \function const Components Slice::GetComponents() const; /*! \function const Components Slice::getComponents() const;
* \Return the collection of components lying on the slice. * \Return the collection of components lying on the slice.
*/ */
/*! \function const Components Slice::GetComponentsUnder(const Box& area) const; /*! \function const Components Slice::getComponentsUnder(const Box& area) const;
* \Return the collection of components of the slice whose bounding box * \Return the collection of components of the slice whose bounding box
* intersects the rectangular region defined by \c \<area\>. * intersects the rectangular region defined by \c \<area\>.
*/ */

32
hurricane/doc/hurricane/SlotAdapter.dox
View File

@ -77,15 +77,15 @@ namespace MyTool {
protected: protected:
int _value; int _value;
public: public:
int GetValue () const { return _value; } int getValue () const { return _value; }
virtual string _getTypeName() const { return "MyClass"; }; virtual string _getTypeName() const { return "MyClass"; };
virtual string _getString () const { return "<MyClass"+GetString(_value)+">"; }; virtual string _getString () const { return "<MyClass"+getString(_value)+">"; };
virtual Record* _getRecord () const; virtual Record* _getRecord () const;
}; };
Record* MyClass::GetRecord () const { Record* MyClass::getRecord () const {
Record* record = new Record(_getString()); Record* record = new Record(_getString());
record->Add ( GetSlot("_value",&_value) ); record->Add ( getSlot("_value",&_value) );
return record; return record;
} }
} // End of MyTool namespace. } // End of MyTool namespace.
@ -122,21 +122,21 @@ namespace MyTool {
protected: protected:
int _value; int _value;
public: public:
int GetValue () const { return _value; } int getValue () const { return _value; }
string _getTypeName() const { return "MyLightClass"; }; string _getTypeName() const { return "MyLightClass"; };
string _getString () const { return "<MyLightClass"+GetString(_value)+">"; }; string _getString () const { return "<MyLightClass"+getString(_value)+">"; };
Record* _getRecord () const; Record* _getRecord () const;
}; };
Record* MyLightClass::GetRecord () const { Record* MyLightClass::getRecord () const {
Record* record = new Record(_getString()); Record* record = new Record(_getString());
record->Add ( GetSlot("_value",&_value) ); record->Add ( getSlot("_value",&_value) );
return record; return record;
} }
} // End of MyTool namespace. } // End of MyTool namespace.
\endcode \endcode
* *
* The methods \b _getTypeName() , \b _getString() and \b GetRecord() * The methods \b _getTypeName() , \b _getString() and \b getRecord()
* are now non-virtual and there's no call to \b SetNestedSlotAdapter() . * are now non-virtual and there's no call to \b SetNestedSlotAdapter() .
* *
* *
@ -158,21 +158,21 @@ template<>
\endcode \endcode
* *
* *
* \section sGetStringAndGetSlot GetString() and GetSlot() functions * \section sgetStringAndgetSlot getString() and getSlot() functions
* *
* When a class or type is provided with Inspector support, * When a class or type is provided with Inspector support,
* you may uses the two generic functions below : * you may uses the two generic functions below :
\code \code
template<typename T> inline string GetString ( T* t ); template<typename T> inline string getString ( T* t );
template<typename T> inline string GetString ( T t ); template<typename T> inline string getString ( T t );
template<typename T> inline Hurricane::Slot* GetSlot ( const string& name, T* t ); template<typename T> inline Hurricane::Slot* getSlot ( const string& name, T* t );
template<typename T> inline Hurricane::Slot* GetSlot ( const string& name, T t ); template<typename T> inline Hurricane::Slot* getSlot ( const string& name, T t );
\endcode \endcode
* *
* GetString() may be used to print some debugging informations * getString() may be used to print some debugging informations
* on \stdout. * on \stdout.
* *
* GetSlot() used to built the various entries in a \b _getRecord() * getSlot() used to built the various entries in a \b _getRecord()
* method. * method.
* *
* <b>Argument type policy</b> * <b>Argument type policy</b>

22
hurricane/doc/hurricane/Technology.dox
View File

@ -24,7 +24,7 @@
*/ */
// \{ // \{
/*! \function Technology* Technology::Create ( DataBase* dataBase, const Name& name ); /*! \function Technology* Technology::create ( DataBase* dataBase, const Name& name );
* \Return a newly created technology named \c \<name\> for the data base \c \<dataBase\>. * \Return a newly created technology named \c \<name\> for the data base \c \<dataBase\>.
* *
* \caution Throws an exception if the \c dataBase is \NULL, if the name is empty or if * \caution Throws an exception if the \c dataBase is \NULL, if the name is empty or if
@ -38,27 +38,27 @@
*/ */
// \{ // \{
/*! \function DataBase* Technology::GetDataBase () const; /*! \function DataBase* Technology::getDataBase () const;
* \Return the DataBase owning the technology. * \Return the DataBase owning the technology.
*/ */
/*! \function const Name& Technology::GetName () const; /*! \function const Name& Technology::getName () const;
* \Return the technology name. * \Return the technology name.
*/ */
/*! \function Layer* Technology::GetLayer ( const Name& name ) const; /*! \function Layer* Technology::getLayer ( const Name& name ) const;
* \Return the Layer named \c \<name\> if it exists, else \NULL. * \Return the Layer named \c \<name\> if it exists, else \NULL.
*/ */
/*! \function BasicLayer* Technology::GetBasicLayer ( const Name& name ) const; /*! \function BasicLayer* Technology::getBasicLayer ( const Name& name ) const;
* \Return the Layer named \c \<name\> if it exists and is a BasicLayer, else \NULL. * \Return the Layer named \c \<name\> if it exists and is a BasicLayer, else \NULL.
*/ */
/*! \function CompositeLayer* Technology::GetCompositeLayer ( const Name& name ) const; /*! \function CompositeLayer* Technology::getCompositeLayer ( const Name& name ) const;
* \Return the Layer named \c \<name\> if it exists and is a CompositeLayer, else \NULL. * \Return the Layer named \c \<name\> if it exists and is a CompositeLayer, else \NULL.
*/ */
/*! \function Layers Technology::GetLayers () const; /*! \function Layers Technology::getLayers () const;
* \Return Returns the collection of layers of the technology. * \Return Returns the collection of layers of the technology.
* *
* \remark The layers are traversed according to their * \remark The layers are traversed according to their
@ -69,17 +69,17 @@
* importance). * importance).
*/ */
/*! \function BasicLayers Technology::GetBasicLayers () const; /*! \function BasicLayers Technology::getBasicLayers () const;
* \Return Returns the collection of basic layers of the technology * \Return Returns the collection of basic layers of the technology
* (uses the same order). * (uses the same order).
*/ */
/*! \function BasicLayers Technology::GetBasicLayers ( const Layer::Mask& mask ) const; /*! \function BasicLayers Technology::getBasicLayers ( const Layer::Mask& mask ) const;
* \Return Returns the collection of basic layers of the technology * \Return Returns the collection of basic layers of the technology
* which matches the Layer mask \c \<mask\> (uses the same order). * which matches the Layer mask \c \<mask\> (uses the same order).
*/ */
/*! \function CompositeLayers Technology::GetCompositeLayers () const; /*! \function CompositeLayers Technology::getCompositeLayers () const;
* \Return Returns the collection of composite layers of the technology * \Return Returns the collection of composite layers of the technology
* (uses the same order). * (uses the same order).
*/ */
@ -91,7 +91,7 @@
*/ */
// \{ // \{
/*! \function void Technology::SetName ( const Name& name ); /*! \function void Technology::setName ( const Name& name );
* Allows to change the technology name (if empty name, throws an exception). * Allows to change the technology name (if empty name, throws an exception).
*/ */

54
hurricane/doc/hurricane/Transformation.dox
View File

@ -122,88 +122,88 @@ TO::R1
*/ */
// \{ // \{
/*! \function const Unit& Transformation::GetTx() const; /*! \function const Unit& Transformation::getTx() const;
* \Return the horizontal component of the translation. * \Return the horizontal component of the translation.
*/ */
/*! \function const Unit& Transformation::GetTy() const; /*! \function const Unit& Transformation::getTy() const;
* \Return the vertical component of the translation. * \Return the vertical component of the translation.
*/ */
/*! \function Point Transformation::GetTranslation() const; /*! \function Point Transformation::getTranslation() const;
* \Return the translation component of the transformation. * \Return the translation component of the transformation.
*/ */
/*! \function const Translation::Orientation& Transformation::GetOrientation() const; /*! \function const Translation::Orientation& Transformation::getOrientation() const;
* \Return the orientation of the transformation (may be used in a * \Return the orientation of the transformation (may be used in a
* switch). * switch).
*/ */
/*! \function Unit Transformation::GetX(const Unit& x, const Unit& y) const; /*! \function Unit Transformation::getX(const Unit& x, const Unit& y) const;
* \Return the point abscissa resulting of the transformation * \Return the point abscissa resulting of the transformation
* application on the point defined by \c \<x\> et \c \<y\>. * application on the point defined by \c \<x\> et \c \<y\>.
*/ */
/*! \function Unit Transformation::GetY(const Unit& x, const Unit& y) const; /*! \function Unit Transformation::getY(const Unit& x, const Unit& y) const;
* \Return the point ordinate resulting of the transformation * \Return the point ordinate resulting of the transformation
* application on the point defined by \c \<x\> et \c \<y\>. * application on the point defined by \c \<x\> et \c \<y\>.
*/ */
/*! \function Unit Transformation::GetX(const Point& point) const; /*! \function Unit Transformation::getX(const Point& point) const;
* \Return the point abscissa resulting of the transformation * \Return the point abscissa resulting of the transformation
* application on \c \<point\>. * application on \c \<point\>.
*/ */
/*! \function Unit Transformation::GetY(const Point& point) const; /*! \function Unit Transformation::getY(const Point& point) const;
* \Return the point ordinate resulting of the transformation * \Return the point ordinate resulting of the transformation
* application on \c \<point\>. * application on \c \<point\>.
*/ */
/*! \function Unit Transformation::GetDx(const Unit& dx, const Unit& dy) const; /*! \function Unit Transformation::getDx(const Unit& dx, const Unit& dy) const;
* \Return the horizontal component of the vector resulting from the * \Return the horizontal component of the vector resulting from the
* application of the transformation on the vector defined by * application of the transformation on the vector defined by
* \c \<dx\> et \c \<dy\>. * \c \<dx\> et \c \<dy\>.
*/ */
/*! \function Unit Transformation::GetDy(const Unit& dx, const Unit& dy) const; /*! \function Unit Transformation::getDy(const Unit& dx, const Unit& dy) const;
* \Return the vertical component of the vector resulting from the * \Return the vertical component of the vector resulting from the
* application of the transformation on the vector defined by * application of the transformation on the vector defined by
* \c \<dx\> et \c \<dy\>. * \c \<dx\> et \c \<dy\>.
*/ */
/*! \function Point Transformation::GetPoint(const Unit& x, const Unit& y) const; /*! \function Point Transformation::getPoint(const Unit& x, const Unit& y) const;
* \Return the point resulting from the application of the * \Return the point resulting from the application of the
* transformation on the point defined by \c \<dx\> et * transformation on the point defined by \c \<dx\> et
* \c \<dy\>. * \c \<dy\>.
*/ */
/*! \function Point Transformation::GetPoint(const Point& point) const; /*! \function Point Transformation::getPoint(const Point& point) const;
* \Return the point resulting from the application of the * \Return the point resulting from the application of the
* transformation on \c \<point\>. * transformation on \c \<point\>.
*/ */
/*! \function Box Transformation::GetBox(const Unit& x1, const Unit& y1, const Unit& x2, const Unit& y2) const; /*! \function Box Transformation::getBox(const Unit& x1, const Unit& y1, const Unit& x2, const Unit& y2) const;
* \Return the box resulting from the application of the transformation * \Return the box resulting from the application of the transformation
* on the box defined by \c \<x1\>, \c \<y1\>, \c \<x2\> et * on the box defined by \c \<x1\>, \c \<y1\>, \c \<x2\> et
* \c \<y2\>. * \c \<y2\>.
*/ */
/*! \function Box Transformation::GetBox(const Point& point1, const Point& point2) const; /*! \function Box Transformation::getBox(const Point& point1, const Point& point2) const;
* \Return the box resulting from the application of the transformation * \Return the box resulting from the application of the transformation
* on the box defined by \c \<point1\> et \c \<point2\>. * on the box defined by \c \<point1\> et \c \<point2\>.
*/ */
/*! \function Box Transformation::GetBox(const Box& box) const; /*! \function Box Transformation::getBox(const Box& box) const;
* \Return the box resulting from the application of the transformation * \Return the box resulting from the application of the transformation
* on the box \c \<box\>. * on the box \c \<box\>.
*/ */
/*! \function Transformation Transformation::GetTransformation(const Transformation& transformation) const; /*! \function Transformation Transformation::getTransformation(const Transformation& transformation) const;
* \Return the transformation resulting from the application of the * \Return the transformation resulting from the application of the
* transformation on the transformation \c \<transformation\>. * transformation on the transformation \c \<transformation\>.
*/ */
/*! \function Transformation Transformation::GetInvert() const; /*! \function Transformation Transformation::getInvert() const;
* \Return the inverse transformation. * \Return the inverse transformation.
*/ */
@ -214,8 +214,8 @@ TO::R1
*/ */
// \{ // \{
/*! \function Transformation& Transformation::Invert(); /*! \function Transformation& Transformation::invert();
* Inverts the transformation \c \<this\> and returns a * inverts the transformation \c \<this\> and returns a
* reference to it in order to apply in sequence a new function. * reference to it in order to apply in sequence a new function.
*/ */
@ -225,13 +225,13 @@ TO::R1
/*! \section secTransformationTransformers Transformers /*! \section secTransformationTransformers Transformers
* *
* *
* <b>Transformation::ApplyOn</b> * <b>Transformation::applyOn</b>
* *
* <b>Transformation::ApplyOn</b> * <b>Transformation::applyOn</b>
* *
* <b>Transformation::ApplyOn</b> * <b>Transformation::applyOn</b>
* *
* <b>Transformation::ApplyOn</b> * <b>Transformation::applyOn</b>
*/ */
@ -240,20 +240,20 @@ TO::R1
*/ */
// \{ // \{
/*! \function void Transformation::ApplyOn(Unit& x, Unit& y) const; /*! \function void Transformation::applyOn(Unit& x, Unit& y) const;
* Applies the transformation on the coordinates given in * Applies the transformation on the coordinates given in
* arguments. * arguments.
*/ */
/*! \function void Transformation::ApplyOn(Point& point) const; /*! \function void Transformation::applyOn(Point& point) const;
* Applies the transformation on the point given in argument. * Applies the transformation on the point given in argument.
*/ */
/*! \function void Transformation::ApplyOn(Box& box) const; /*! \function void Transformation::applyOn(Box& box) const;
* Applies the transformation on the box given in argument. * Applies the transformation on the box given in argument.
*/ */
/*! \function void Transformation::ApplyOn(Transformation& transformation) const; /*! \function void Transformation::applyOn(Transformation& transformation) const;
* Applies the transformation on the transformation given in * Applies the transformation on the transformation given in
* argument. This last one becomes then the transformation * argument. This last one becomes then the transformation
* resulting of the product of those two. * resulting of the product of those two.

46
hurricane/doc/hurricane/Unit.dox
View File

@ -28,9 +28,9 @@
* unit equal to 23540. * unit equal to 23540.
* *
* <ul> * <ul>
* <li><b>Unit::GetPrecision</b> * <li><b>Unit::getPrecision</b>
* <li><b>Unit::GetMaximalPrecisionAllowed</b> * <li><b>Unit::getMaximalPrecisionAllowed</b>
* <li><b>Unit::SetPrecision</b> * <li><b>Unit::setPrecision</b>
* </ul> * </ul>
* *
* *
@ -38,27 +38,27 @@
* *
* The resolution is associated to the precision. Indeed it * The resolution is associated to the precision. Indeed it
* represents the external value associated to the smallest * represents the external value associated to the smallest
* unit, that is the value returned by GetValue(GetUnit(1)). * unit, that is the value returned by getValue(getUnit(1)).
* *
* <b>Unit::GetResolution</b> * <b>Unit::getResolution</b>
* *
* *
* \section secUnitGrid Grid * \section secUnitGrid Grid
* *
* <ul> * <ul>
* <li><b>Unit::GetGridStep</b> * <li><b>Unit::getGridStep</b>
* <li><b>Unit::SetGridStep</b> * <li><b>Unit::setGridStep</b>
* <li><b>Unit::IsOnGrid</b> * <li><b>Unit::isOnGrid</b>
* <li><b>Unit::GetOnGridUnit</b> * <li><b>Unit::getOnGridUnit</b>
* </ul> * </ul>
* *
* *
* \section secUnitTranslators Translators * \section secUnitTranslators Translators
* *
* <ul> * <ul>
* <li><b>Unit::GetUnit</b> * <li><b>Unit::getUnit</b>
* <li><b>Unit::GetValue</b> * <li><b>Unit::getValue</b>
* <li><b>Unit::GetValueString</b> * <li><b>Unit::getValueString</b>
* </ul> * </ul>
*/ */
@ -68,7 +68,7 @@
*/ */
// \{ // \{
/*! \function bool Unit::IsOnGrid(const Unit& unit, int n = 1); /*! \function bool Unit::isOnGrid(const Unit& unit, int n = 1);
* \Return \true if the unit is on grid, else \false. The argument * \Return \true if the unit is on grid, else \false. The argument
* \c \<n\> allows to consider on grid only multiples of * \c \<n\> allows to consider on grid only multiples of
* \c \<n\> grid steps. So if n=1 all grid steps are considered, * \c \<n\> grid steps. So if n=1 all grid steps are considered,
@ -76,23 +76,23 @@
*/ */
/*! \function unsigned Unit::GetPrecision(); /*! \function unsigned Unit::getPrecision();
* \Return the current precision (whose default is fixed to 0). * \Return the current precision (whose default is fixed to 0).
*/ */
/*! \function unsigned Unit::GetMaximalPrecisionAllowed(); /*! \function unsigned Unit::getMaximalPrecisionAllowed();
* \Return the maximal precision allowed (currently fixed to 3). * \Return the maximal precision allowed (currently fixed to 3).
*/ */
/*! \function double Unit::GetResolution(); /*! \function double Unit::getResolution();
* \Return the current resolution. * \Return the current resolution.
*/ */
/*! \function const Unit& Unit::GetGridStep(); /*! \function const Unit& Unit::getGridStep();
* \Return the grid step. * \Return the grid step.
*/ */
/*! \function Unit Unit::GetOnGridUnit(const Unit& unit, int s = 0); /*! \function Unit Unit::getOnGridUnit(const Unit& unit, int s = 0);
* \Return the closest location on grid if the argument \c \<s\> equals * \Return the closest location on grid if the argument \c \<s\> equals
* 0, the closest inferior location on grid if the argument * 0, the closest inferior location on grid if the argument
* \c \<s\> equals -1 and the closest superior location on grid * \c \<s\> equals -1 and the closest superior location on grid
@ -101,17 +101,17 @@
* \remark Throw an exception for any other \c \<s\> argument value. * \remark Throw an exception for any other \c \<s\> argument value.
*/ */
/*! \function Unit GetUnit(double value); /*! \function Unit getUnit(double value);
* \Return the unit corresponding to the value \c \<value\> according to * \Return the unit corresponding to the value \c \<value\> according to
* the current precision. * the current precision.
*/ */
/*! \function double GetValue(const Unit& unit); /*! \function double getValue(const Unit& unit);
* \Return the external value associated to the unit \c \<unit\> * \Return the external value associated to the unit \c \<unit\>
* according to the current precision. * according to the current precision.
*/ */
/*! \function string GetValueString(const Unit& unit); /*! \function string getValueString(const Unit& unit);
* \Return a character string representing the external value of * \Return a character string representing the external value of
* \c \<unit\>. * \c \<unit\>.
* *
@ -121,7 +121,7 @@
*/ */
/*! \function void SetPrecision(unsigned precision); /*! \function void setPrecision(unsigned precision);
* Allows to set the precision at a requested value. This must * Allows to set the precision at a requested value. This must
* be done at the begining of the program (before the creation * be done at the begining of the program (before the creation
* of the first unit) and not changed for the following (unless * of the first unit) and not changed for the following (unless
@ -132,7 +132,7 @@
* is greater than the maximal one. * is greater than the maximal one.
*/ */
/*! \function void SetGridStep(const Unit& gridStep); /*! \function void setGridStep(const Unit& gridStep);
* Allows to change the grid step. * Allows to change the grid step.
*/ */

24
hurricane/doc/hurricane/Vertical.dox
View File

@ -39,8 +39,8 @@
*/ */
// \{ // \{
/*! \function Vertical* Vertical::Create(Component* source, Component* target, Layer* layer,const Unit& x,const Unit& width = 0,const Unit& dySource = 0, const Unit& dyTarget = 0); /*! \function Vertical* Vertical::create(Component* source, Component* target, Layer* layer,const Unit& x,const Unit& width = 0,const Unit& dySource = 0, const Unit& dyTarget = 0);
* Creates and returns a vertical segment whose origin lies * creates and returns a vertical segment whose origin lies
* (through an offset equal to \c \<dySource\>) on * (through an offset equal to \c \<dySource\>) on
* \c \<source\>, whose extremity lies (through an offset equal * \c \<source\>, whose extremity lies (through an offset equal
* to \c \<dyTarget\>) on \c \<target\>, with layer * to \c \<dyTarget\>) on \c \<target\>, with layer
@ -52,8 +52,8 @@
* same net. * same net.
*/ */
/*! \function Vertical* Vertical::Create(Net* net, Layer* layer, const Unit& x, const Unit& width = 0,const Unit& dySource = 0, const Unit& dyTarget = 0); /*! \function Vertical* Vertical::create(Net* net, Layer* layer, const Unit& x, const Unit& width = 0,const Unit& dySource = 0, const Unit& dyTarget = 0);
* Creates and returns an absolute vertical segment with layer * creates and returns an absolute vertical segment with layer
* \c \<layer\>, located at abscissa \c \<x\> and of width * \c \<layer\>, located at abscissa \c \<x\> and of width
* \c \<width\>. The differents extremities ordinates are given * \c \<width\>. The differents extremities ordinates are given
* by \c \<dySource\> and \c \<dyTarget\>. * by \c \<dySource\> and \c \<dyTarget\>.
@ -69,20 +69,20 @@
*/ */
// \{ // \{
/*! \function const Unit& Vertical::GetDySource() const; /*! \function const Unit& Vertical::getDySource() const;
* \Return the relative source ordinate of the segment (may be absolute * \Return the relative source ordinate of the segment (may be absolute
* if the source extremity isn't anchored). * if the source extremity isn't anchored).
* *
* \remark If you want to get the absolute one use the member function * \remark If you want to get the absolute one use the member function
* GetSourceX() defined at the Segment level. * getSourceX() defined at the Segment level.
*/ */
/*! \function const Unit& Vertical::GetDyTarget() const; /*! \function const Unit& Vertical::getDyTarget() const;
* \Return the relative target ordinate of the segment (may be absolute * \Return the relative target ordinate of the segment (may be absolute
* if the target extremity isn't anchored). * if the target extremity isn't anchored).
* *
* \remark If you want to get the absolute one use the member function * \remark If you want to get the absolute one use the member function
* GetTargetX() defined at the Segment level. * getTargetX() defined at the Segment level.
*/ */
// \} // \}
@ -92,12 +92,12 @@
*/ */
// \{ // \{
/*! \function void Vertical::SetX(const Unit& x); /*! \function void Vertical::setX(const Unit& x);
* Sets the abscissa of the segment. * sets the abscissa of the segment.
*/ */
/*! \function void Vertical::Translate(const Unit& dx); /*! \function void Vertical::translate(const Unit& dx);
* Translate horizontaly the vertical segment of the quantity * translate horizontaly the vertical segment of the quantity
* \c \<dx\>. * \c \<dx\>.
*/ */

193
hurricane/doc/hurricane/doxyfile
View File

@ -5,7 +5,7 @@
PROJECT_NAME = "Hurricane" PROJECT_NAME = "Hurricane"
PROJECT_NUMBER = 3.0 PROJECT_NUMBER = 3.0
OUTPUT_DIRECTORY = html OUTPUT_DIRECTORY = .
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
#USE_WINDOWS_ENCODING = NO #USE_WINDOWS_ENCODING = NO
#DOXYFILE_ENCODING = UTF-8 #DOXYFILE_ENCODING = UTF-8
@ -19,7 +19,7 @@ SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = YES DETAILS_AT_TOP = YES
INHERIT_DOCS = YES INHERIT_DOCS = NO
DISTRIBUTE_GROUP_DOC = NO DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 2 TAB_SIZE = 2
@ -62,7 +62,7 @@ SUBGROUPING = YES
# -------------------------------------------------------------------- # --------------------------------------------------------------------
# Build related configuration options # Build related configuration options
EXTRACT_ALL = YES EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_CLASSES = YES
@ -101,84 +101,131 @@ INPUT = \
../../src/hurricane/hurricane/SlotAdapter.h \ ../../src/hurricane/hurricane/SlotAdapter.h \
SlotAdapter.dox \ SlotAdapter.dox \
../../src/hurricane/hurricane/Commons.h \ ../../src/hurricane/hurricane/Commons.h \
../../src/hurricane/hurricane/DataBase.h \ Commons.dox \
../../src/hurricane/hurricane/Technology.h \
../../src/hurricane/hurricane/DBos.h \
../../src/hurricane/hurricane/DBo.h \
../../src/hurricane/hurricane/Entities.h \
../../src/hurricane/hurricane/Entity.h \
../../src/hurricane/hurricane/Cells.h \
../../src/hurricane/hurricane/Cell.h \
../../src/hurricane/hurricane/BasicLayers.h \
../../src/hurricane/hurricane/BasicLayer.h \
../../src/hurricane/hurricane/Boxes.h \
../../src/hurricane/hurricane/Box.h \
../../src/hurricane/hurricane/Collection.h \
../../src/hurricane/hurricane/Components.h \
../../src/hurricane/hurricane/Component.h \
../../src/hurricane/hurricane/CompositeLayers.h \
../../src/hurricane/hurricane/CompositeLayer.h \
../../src/hurricane/hurricane/Contacts.h \
../../src/hurricane/hurricane/Contact.h \
../../src/hurricane/hurricane/Error.h \
../../src/hurricane/hurricane/Exception.h \ ../../src/hurricane/hurricane/Exception.h \
../../src/hurricane/hurricane/Filter.h \ ../../src/hurricane/hurricane/Error.h \
../../src/hurricane/hurricane/Locator.h \ ../../src/hurricane/hurricane/Warning.h \
../../src/hurricane/hurricane/Gos.h \
../../src/hurricane/hurricane/Go.h \
../../src/hurricane/hurricane/Hooks.h \
../../src/hurricane/hurricane/Hook.h \
../../src/hurricane/hurricane/Horizontals.h \
../../src/hurricane/hurricane/Horizontal.h \
../../src/hurricane/hurricane/Instances.h \
../../src/hurricane/hurricane/Instance.h \
../../src/hurricane/hurricane/Interruption.h \ ../../src/hurricane/hurricane/Interruption.h \
../../src/hurricane/hurricane/Intervals.h \ Exception.dox \
../../src/hurricane/hurricane/Interval.h \ ../../src/hurricane/hurricane/Collection.h \
../../src/hurricane/hurricane/Layers.h \
../../src/hurricane/hurricane/Layer.h \
../../src/hurricane/hurricane/Libraries.h \
../../src/hurricane/hurricane/Library.h \
../../src/hurricane/hurricane/ListCollection.h \ ../../src/hurricane/hurricane/ListCollection.h \
../../src/hurricane/hurricane/Locator.h \
../../src/hurricane/hurricane/MapCollection.h \ ../../src/hurricane/hurricane/MapCollection.h \
../../src/hurricane/hurricane/Names.h \ ../../src/hurricane/hurricane/SetCollection.h \
../../src/hurricane/hurricane/Name.h \ ../../src/hurricane/hurricane/VectorCollection.h \
../../src/hurricane/hurricane/Nets.h \ Collection.dox \
../../src/hurricane/hurricane/Net.h \ ../../src/hurricane/hurricane/Locator.h \
../../src/hurricane/hurricane/Occurrences.h \ ../../src/hurricane/hurricane/Locator.h \
../../src/hurricane/hurricane/Occurrence.h \ Locator.dox \
../../src/hurricane/hurricane/Pads.h \ ../../src/hurricane/hurricane/Filter.h \
../../src/hurricane/hurricane/Pad.h \ Filter.dox \
../../src/hurricane/hurricane/Pathes.h \ ../../src/hurricane/hurricane/Relation.h \
../../src/hurricane/hurricane/Path.h \ Relation.dox \
../../src/hurricane/hurricane/Pins.h \ ../../src/hurricane/hurricane/Tabulation.h \
../../src/hurricane/hurricane/Pin.h \ Tabulation.dox \
../../src/hurricane/hurricane/Plugs.h \ ../../src/hurricane/hurricane/Unit.h \
../../src/hurricane/hurricane/Plug.h \ Unit.dox \
../../src/hurricane/hurricane/Points.h \ ../../src/hurricane/hurricane/Points.h \
../../src/hurricane/hurricane/Point.h \ ../../src/hurricane/hurricane/Point.h \
../../src/hurricane/hurricane/Properties.h \ Point.dox \
../../src/hurricane/hurricane/Property.h \ ../../src/hurricane/hurricane/Boxes.h \
../../src/hurricane/hurricane/QuadTree.h \ ../../src/hurricane/hurricane/Box.h \
../../src/hurricane/hurricane/Quarks.h \ Box.dox \
../../src/hurricane/hurricane/Quark.h \ ../../src/hurricane/hurricane/Intervals.h \
../../src/hurricane/hurricane/Relation.h \ ../../src/hurricane/hurricane/Interval.h \
../../src/hurricane/hurricane/Rubbers.h \ Interval.dox \
../../src/hurricane/hurricane/Rubber.h \ ../../src/hurricane/hurricane/Transformation.h \
Transformation.dox \
../../src/hurricane/hurricane/Names.h \
../../src/hurricane/hurricane/Name.h \
Name.dox \
\
../../src/hurricane/hurricane/DBos.h \
../../src/hurricane/hurricane/DBo.h \
DBo.dox \
../../src/hurricane/hurricane/DataBase.h \
DataBase.dox \
../../src/hurricane/hurricane/Technology.h \
Technology.dox \
../../src/hurricane/hurricane/Layers.h \
../../src/hurricane/hurricane/Layer.h \
Layer.dox \
../../src/hurricane/hurricane/BasicLayers.h \
../../src/hurricane/hurricane/BasicLayer.h \
BasicLayer.dox \
../../src/hurricane/hurricane/CompositeLayers.h \
../../src/hurricane/hurricane/CompositeLayer.h \
CompositeLayer.dox \
../../src/hurricane/hurricane/Libraries.h \
../../src/hurricane/hurricane/Library.h \
Library.dox \
../../src/hurricane/hurricane/Entities.h \
../../src/hurricane/hurricane/Entity.h \
Entity.dox \
../../src/hurricane/hurricane/Cells.h \
../../src/hurricane/hurricane/Cell.h \
Cell.dox \
../../src/hurricane/hurricane/Nets.h \
../../src/hurricane/hurricane/Net.h \
Cell.dox \
../../src/hurricane/hurricane/Gos.h \
../../src/hurricane/hurricane/Go.h \
Cell.dox \
../../src/hurricane/hurricane/Instances.h \
../../src/hurricane/hurricane/Instance.h \
Cell.dox \
../../src/hurricane/hurricane/Components.h \
../../src/hurricane/hurricane/Component.h \
Component.dox \
../../src/hurricane/hurricane/Plugs.h \
../../src/hurricane/hurricane/Plug.h \
Plug.dox \
../../src/hurricane/hurricane/Contacts.h \
../../src/hurricane/hurricane/Contact.h \
Contact.dox \
../../src/hurricane/hurricane/Pins.h \
../../src/hurricane/hurricane/Pin.h \
Pin.dox \
../../src/hurricane/hurricane/Segments.h \ ../../src/hurricane/hurricane/Segments.h \
../../src/hurricane/hurricane/Segment.h \ ../../src/hurricane/hurricane/Segment.h \
../../src/hurricane/hurricane/SetCollection.h \ Segment.dox \
../../src/hurricane/hurricane/Slices.h \
../../src/hurricane/hurricane/Slice.h \
../../src/hurricane/hurricane/Tabulation.h \
../../src/hurricane/hurricane/Transformation.h \
../../src/hurricane/hurricane/Unit.h \
../../src/hurricane/hurricane/UpdateSession.h \
../../src/hurricane/hurricane/VectorCollection.h \
../../src/hurricane/hurricane/Verticals.h \ ../../src/hurricane/hurricane/Verticals.h \
../../src/hurricane/hurricane/Vertical.h \ ../../src/hurricane/hurricane/Vertical.h \
../../src/hurricane/hurricane/Warning.h Vertical.dox \
../../src/hurricane/hurricane/Horizontals.h \
../../src/hurricane/hurricane/Horizontal.h \
Horizontal.dox \
../../src/hurricane/hurricane/Pads.h \
../../src/hurricane/hurricane/Pad.h \
Pad.dox \
../../src/hurricane/hurricane/Rubbers.h \
../../src/hurricane/hurricane/Rubber.h \
Rubber.dox \
../../src/hurricane/hurricane/Quarks.h \
../../src/hurricane/hurricane/Quark.h \
Quark.dox \
\
../../src/hurricane/hurricane/Properties.h \
../../src/hurricane/hurricane/Property.h \
Property.dox \
\
../../src/hurricane/hurricane/Hooks.h \
../../src/hurricane/hurricane/Hook.h \
Hook.dox \
\
../../src/hurricane/hurricane/Pathes.h \
../../src/hurricane/hurricane/Path.h \
Path.dox \
../../src/hurricane/hurricane/Occurrences.h \
../../src/hurricane/hurricane/Occurrence.h \
Occurrence.dox \
\
../../src/hurricane/hurricane/QuadTree.h \
QuadTree.dox \
../../src/hurricane/hurricane/Slices.h \
../../src/hurricane/hurricane/Slice.h \
Slice.dox \
../../src/hurricane/hurricane/UpdateSession.h \
UpdateSession.dox
FILE_PATTERNS = *.h \ FILE_PATTERNS = *.h \
@ -254,7 +301,7 @@ LATEX_HIDE_INDICES = NO
# -------------------------------------------------------------------- # --------------------------------------------------------------------
# Configuration options related to the RTF output # Configuration options related to the RTF output
GENERATE_RTF = YES GENERATE_RTF = NO
RTF_OUTPUT = rtf RTF_OUTPUT = rtf
COMPACT_RTF = NO COMPACT_RTF = NO
RTF_HYPERLINKS = NO RTF_HYPERLINKS = NO
@ -264,7 +311,7 @@ RTF_EXTENSIONS_FILE =
# -------------------------------------------------------------------- # --------------------------------------------------------------------
# Configuration options related to the man page output # Configuration options related to the man page output
GENERATE_MAN = YES GENERATE_MAN = NO
MAN_OUTPUT = man MAN_OUTPUT = man
MAN_EXTENSION = .3 MAN_EXTENSION = .3
MAN_LINKS = NO MAN_LINKS = NO