coriolis/katabatic/doc/latex/namespaceKatabatic.tex

420 lines
51 KiB
TeX

\hypertarget{namespaceKatabatic}{\section{Katabatic Namespace Reference}
\label{namespaceKatabatic}\index{Katabatic@{Katabatic}}
}
The namespace dedicated to \hyperlink{namespaceKatabatic}{Katabatic}.
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item
class \hyperlink{classKatabatic_1_1BaseObserver}{Base\-Observer}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1Observer}{Observer} Design Pattern, \hyperlink{classKatabatic_1_1Observer}{Observer} part. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1Observer}{Observer}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1Observer}{Observer} Design Pattern, \hyperlink{classKatabatic_1_1Observer}{Observer} part. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1Observable}{Observable}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1Observer}{Observer} Design Pattern, Subject part. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact}
\begin{DoxyCompactList}\small\item\em Abstract base class for \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1LocatorHelper}{Locator\-Helper}
\begin{DoxyCompactList}\small\item\em Locator Helper Collection's Locators. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoContactTerminal}{Auto\-Contact\-Terminal}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} Terminal (S/\-T is a Terminal) \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoContactTurn}{Auto\-Contact\-Turn}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} Turn (one H, one V) \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoContactHTee}{Auto\-Contact\-H\-Tee}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} H-\/\-Tee (two H, one V) \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoContactVTee}{Auto\-Contact\-V\-Tee}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} V-\/\-Tee (one H, two V) \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}
\begin{DoxyCompactList}\small\item\em Abstract base class for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegments__OnContact}{Auto\-Segments\-\_\-\-On\-Contact}
\begin{DoxyCompactList}\small\item\em All \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} anchored on a Contact. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegments__Aligneds}{Auto\-Segments\-\_\-\-Aligneds}
\begin{DoxyCompactList}\small\item\em All aligned \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} of a set. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegments__Perpandiculars}{Auto\-Segments\-\_\-\-Perpandiculars}
\begin{DoxyCompactList}\small\item\em All perpandicular \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} to a set of aligneds. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegments__AnchorOnGCell}{Auto\-Segments\-\_\-\-Anchor\-On\-G\-Cell}
\begin{DoxyCompactList}\small\item\em All \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} Beginning and/or Stopping in a \hyperlink{classKatabatic_1_1GCell}{G\-Cell}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegments__IsAccountable}{Auto\-Segments\-\_\-\-Is\-Accountable}
\begin{DoxyCompactList}\small\item\em Filter to select accoutable \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoSegments__InDirection}{Auto\-Segments\-\_\-\-In\-Direction}
\begin{DoxyCompactList}\small\item\em Filter to select \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} in a given direction. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoHorizontal}{Auto\-Horizontal}
\begin{DoxyCompactList}\small\item\em Concrete Horizontal \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1AutoVertical}{Auto\-Vertical}
\begin{DoxyCompactList}\small\item\em Concrete Vertical \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1GCell}{G\-Cell}
\begin{DoxyCompactList}\small\item\em Routing Global Cell. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1GCellDensitySet}{G\-Cell\-Density\-Set}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1GCell}{G\-Cell} Set, sorted by density. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1BaseGrid}{Base\-Grid}
\begin{DoxyCompactList}\small\item\em Abstract Base Class for Irregular \hyperlink{classKatabatic_1_1Grid}{Grid}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1Grid}{Grid}
\begin{DoxyCompactList}\small\item\em Template Class for Regular \hyperlink{classKatabatic_1_1Grid}{Grid}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1GCellGrid}{G\-Cell\-Grid}
\begin{DoxyCompactList}\small\item\em \hyperlink{classKatabatic_1_1GCell}{G\-Cell} \hyperlink{classKatabatic_1_1Grid}{Grid}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1Session}{Session}
\begin{DoxyCompactList}\small\item\em Modification \hyperlink{classKatabatic_1_1Session}{Session} for \hyperlink{namespaceKatabatic}{Katabatic}. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1ChipTools}{Chip\-Tools}
\begin{DoxyCompactList}\small\item\em Utilities for Chip Level Design. \end{DoxyCompactList}\item
class \hyperlink{classKatabatic_1_1KatabaticEngine}{Katabatic\-Engine}
\begin{DoxyCompactList}\small\item\em The \hyperlink{namespaceKatabatic}{Katabatic} Tool. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
typedef {\bf Hurricane\-::\-Filter}\\*
$<$ \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} $\ast$ $>$ \hyperlink{namespaceKatabatic_a790418bb65a9a13859868df3e8f53598}{Auto\-Segment\-H\-F}
\item
typedef {\bf Hurricane\-::\-Locator}\\*
$<$ \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} $\ast$ $>$ \hyperlink{namespaceKatabatic_a40ef13471fd0e797b75d3c436813fe65}{Auto\-Segment\-H\-L}
\item
typedef {\bf Hurricane\-::\-Collection}\\*
$<$ \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} $\ast$ $>$ \hyperlink{namespaceKatabatic_acb3628dc7705fefe38a665cfe43efa6e}{Auto\-Segment\-H\-C}
\item
typedef {\bf Generic\-Collection}\\*
$<$ \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} $\ast$ $>$ \hyperlink{namespaceKatabatic_a2221b0ddbc24f331809fc86f98e38041}{Auto\-Segments}
\item
typedef {\bf Generic\-Locator}\\*
$<$ \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} $\ast$ $>$ \hyperlink{namespaceKatabatic_ace866cc8e09faf80f71a4087bb8e5870}{Auto\-Segment\-Locator}
\item
typedef {\bf Generic\-Filter}\\*
$<$ \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} $\ast$ $>$ \hyperlink{namespaceKatabatic_a13ffc994c98e1a878e61a927de0509c8}{Auto\-Segment\-Filter}
\item
typedef {\bf Generic\-Collection}\\*
$<$ \hyperlink{classKatabatic_1_1GCell}{G\-Cell} $\ast$ $>$ \hyperlink{namespaceKatabatic_ab68f9dfbbc79fd999773beef8561bc31}{G\-Cells}
\item
typedef {\bf Generic\-Locator}$<$ \hyperlink{classKatabatic_1_1GCell}{G\-Cell} $\ast$ $>$ \hyperlink{namespaceKatabatic_ae192ef170a0ad390902e435ac1e6796a}{G\-Cell\-Locator}
\item
typedef {\bf Generic\-Filter}$<$ \hyperlink{classKatabatic_1_1GCell}{G\-Cell} $\ast$ $>$ \hyperlink{namespaceKatabatic_a7d07e23d45818a2ae5f6881ce0ec7403}{G\-Cell\-Filter}
\end{DoxyCompactItemize}
\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum \hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217}{Function\-Flag} \{ , \\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af314588109fcc5f5ee1c42e5fd4d0ed5}{Kb\-Open\-Session} = 0x00000001,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a45a219697151531a23e997b11118e08a}{Kb\-Realignate} = 0x00000002,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af1d61226371622b8063fe47c63cd9dff}{Kb\-Native\-Constraints} = 0x00000004,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217acf76914f1ec05633965f0ac6b1c89959}{Kb\-Force\-Move} = 0x00000008,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a1a9045673c5d3c30b067100f1440ae1b}{Kb\-Horizontal} = 0x00000010,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a284cad95203a27172838b09e396e3590}{Kb\-Vertical} = 0x00000020,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217ae2d033c8f78b61468c827de8db5fe839}{Kb\-With\-Perpands} = 0x00000040,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a8c8fd7a68cd428639057fbc6dbb8c46a}{Kb\-Source} = 0x00000080,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a041350b28d805a40d048fa0be9994a26}{Kb\-Target} = 0x00000100,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217aa5153b2cc25ebccca8616ce20ecd727a}{Kb\-Warn\-On\-Error} = 0x00000200
, \\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a3f95c1f06fe0b58b44ccbc57d99f2a5d}{Kb\-Propagate} = 0x00008000
, \\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af756099f1bbe259dd1bf22067dc40eac}{Kb\-Use\-Above\-Layer} = 0x00020000,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a41cbd981337678e042354f340bfae25d}{Kb\-Use\-Below\-Layer} = 0x00040000,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a67bb7c53bbbc73a0e2d1f3f3e16ab679}{Kb\-Dogleg\-On\-Left} = 0x00080000,
\\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217afe7fcb4c332f36e477433169b3d3f515}{Kb\-Dogleg\-On\-Right} = 0x00100000
, \\*
\hyperlink{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a1d6ccf82d04758a0922270d4f469066a}{Kb\-Half\-Slacken} = 0x00800000
\}
\item
enum \hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cda}{Engine\-State} \{ \\*
\hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaa8bae41ad2fa29aaa5020b985b13416e0}{Engine\-Creation} = 1,
\\*
\hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaa5e262eba2c323c8ab5365b5e1364fc1e}{Engine\-Global\-Loaded} = 2,
\\*
\hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaad4f7e86648b59223202a64bde4eda4c7}{Engine\-Active} = 3,
\\*
\hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaae21d68495c3c349ad351ba9692b40bd1}{Engine\-Driving} = 4,
\\*
\hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaafee0f47ec435d9c4e49b98a47683ad03}{Engine\-Pre\-Destroying} = 5,
\\*
\hyperlink{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaafb5f961d4cad2bb9fbda71204061c877}{Engine\-Gutted} = 6
\}
\item
enum \hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24}{Auto\-Contact\-Flag} \{ \\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a66205741ac37bce922c730c95f6984af}{Cnt\-Fixed} = 0x00000001,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a59ca560e6a04e6401054626b8b8f74bc}{Cnt\-Terminal} = 0x00000002,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24aa0a37bdfa4c0097ebfb5f69e612fa57b}{Cnt\-Turn} = 0x00000004,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24ad8d6114e340ad8064617cc3c7b5e62f3}{Cnt\-H\-Tee} = 0x00000008,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24ac8b5263851e6e160bff135cc6ecd45c5}{Cnt\-V\-Tee} = 0x00000010,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a16ebc32170107fe230ddcc2dcbaab66f}{Cnt\-Invalidated} = 0x00000020,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a03218a60eff8f1960babe7e2a300301a}{Cnt\-Invalidated\-Cache} = 0x00000040,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a803ca5191d4aba9d1f53aeec8d137359}{Cnt\-In\-Creation\-Stage} = 0x00000080,
\\*
\hyperlink{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24abe577b4e6bc01e6a506a303ad8ccdf38}{Cnt\-Bad\-Topology} = 0x00000100
\}
\item
enum \hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4}{Auto\-Segment\-Flag} \{ , \\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a275eb973fc7a219eb34d2031309ff75c}{Seg\-Horizontal} = (1$<$$<$ 0),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4aa291777ea80e37ea23e785870d8833ed}{Seg\-Fixed} = (1$<$$<$ 1),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a940d92cb98a61e671a94204701767868}{Seg\-Global} = (1$<$$<$ 2),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a16ef6f2b6b9e44559e41f04c652919ad}{Seg\-Weak\-Global} = (1$<$$<$ 3),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a296b371b45ade66cd1d44bc8898e64d9}{Seg\-Canonical} = (1$<$$<$ 4),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a2d969cfff8aa7da1ac3486924f4786d2}{Seg\-Bipoint} = (1$<$$<$ 5),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ab3a62f799073ef374df7aaa26514c09b}{Seg\-Dogleg} = (1$<$$<$ 6),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a8c676eccde69f8a431ffaf2ffcae7209}{Seg\-Strap} = (1$<$$<$ 7),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ae5f763897c8e6221dcc8177816c72b33}{Seg\-Source\-Top} = (1$<$$<$ 8),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a29f1952fe978a9fdd1902a6fcd085b44}{Seg\-Source\-Bottom} = (1$<$$<$ 9),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a100b7ff78619133970733fedbb34ffa8}{Seg\-Target\-Top} = (1$<$$<$10),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ae600c6015187dddac3860fcc008a2213}{Seg\-Target\-Bottom} = (1$<$$<$11),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4af4dd1db46475e4a16555fb6978a85580}{Seg\-Is\-Reduced} = (1$<$$<$12),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4afc9fc027fe8f457520c3fe6fb1144b2b}{Seg\-Layer\-Change} = (1$<$$<$13)
, \\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a93251a6b8197685e2aaf77a760851557}{Seg\-Strong\-Terminal} = Seg\-Source\-Terminal$|$\-Seg\-Target\-Terminal,
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a7b3e09b8ab4cf676fd308535d7fba892}{Seg\-Weak\-Terminal1} = (1$<$$<$16),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a32f77fa2da27348bcfc294a039efd766}{Seg\-Weak\-Terminal2} = (1$<$$<$17),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a286b96fc8ab2377a2caf92c82352b0c8}{Seg\-Not\-Source\-Aligned} = (1$<$$<$18),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac5042810c9268798def84444d31968ea}{Seg\-Not\-Target\-Aligned} = (1$<$$<$19)
, \\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac47f838c52b3b33b1150eb53133c2383}{Seg\-Slackened} = (1$<$$<$22),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a86d22dbc8fbc045a1e12e25ba357e1d1}{Seg\-Axis\-Set} = (1$<$$<$23),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a3c1d76fecee6a8bd5e12ce3fec013827}{Seg\-Invalidated} = (1$<$$<$24)
, \\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a11c86dd3185eb251b2f3ce536cc2ab34}{Seg\-Invalidated\-Layer} = (1$<$$<$27),
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a01513b74d37a8721370cf7b91fb419ad}{Seg\-Created} = (1$<$$<$28)
, \\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a419e7722198b077c1f71d6c47e2fc2ab}{Seg\-Weak\-Terminal} = Seg\-Strong\-Terminal$|$\-Seg\-Weak\-Terminal1$|$\-Seg\-Weak\-Terminal2,
\\*
\hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a637e0426170a532feac45548e009325d}{Seg\-Not\-Aligned} = Seg\-Not\-Source\-Aligned$|$\-Seg\-Not\-Target\-Aligned
\}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
The namespace dedicated to \hyperlink{namespaceKatabatic}{Katabatic}.
\subsection{Typedef Documentation}
\hypertarget{namespaceKatabatic_a790418bb65a9a13859868df3e8f53598}{\index{Katabatic@{Katabatic}!Auto\-Segment\-H\-F@{Auto\-Segment\-H\-F}}
\index{Auto\-Segment\-H\-F@{Auto\-Segment\-H\-F}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segment\-H\-F}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Hurricane\-::\-Filter}$<$ {\bf Auto\-Segment} $\ast$ $>$ {\bf Auto\-Segment\-H\-F}}}\label{namespaceKatabatic_a790418bb65a9a13859868df3e8f53598}
Shorthand for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} {\bf Hurricane} Filter. \hypertarget{namespaceKatabatic_a40ef13471fd0e797b75d3c436813fe65}{\index{Katabatic@{Katabatic}!Auto\-Segment\-H\-L@{Auto\-Segment\-H\-L}}
\index{Auto\-Segment\-H\-L@{Auto\-Segment\-H\-L}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segment\-H\-L}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Hurricane\-::\-Locator}$<$ {\bf Auto\-Segment} $\ast$ $>$ {\bf Auto\-Segment\-H\-L}}}\label{namespaceKatabatic_a40ef13471fd0e797b75d3c436813fe65}
Shorthand for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} {\bf Hurricane} Locator. \hypertarget{namespaceKatabatic_acb3628dc7705fefe38a665cfe43efa6e}{\index{Katabatic@{Katabatic}!Auto\-Segment\-H\-C@{Auto\-Segment\-H\-C}}
\index{Auto\-Segment\-H\-C@{Auto\-Segment\-H\-C}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segment\-H\-C}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Hurricane\-::\-Collection}$<$ {\bf Auto\-Segment} $\ast$ $>$ {\bf Auto\-Segment\-H\-C}}}\label{namespaceKatabatic_acb3628dc7705fefe38a665cfe43efa6e}
Shorthand for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} {\bf Hurricane} Collection. \hypertarget{namespaceKatabatic_a2221b0ddbc24f331809fc86f98e38041}{\index{Katabatic@{Katabatic}!Auto\-Segments@{Auto\-Segments}}
\index{Auto\-Segments@{Auto\-Segments}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segments}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Generic\-Collection}$<$ {\bf Auto\-Segment} $\ast$ $>$ {\bf Auto\-Segments}}}\label{namespaceKatabatic_a2221b0ddbc24f331809fc86f98e38041}
Shorthand for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} {\bf Hurricane} Generic Collection (collection with {\ttfamily unique\-\_\-ptr$<$$>$} like support). \hypertarget{namespaceKatabatic_ace866cc8e09faf80f71a4087bb8e5870}{\index{Katabatic@{Katabatic}!Auto\-Segment\-Locator@{Auto\-Segment\-Locator}}
\index{Auto\-Segment\-Locator@{Auto\-Segment\-Locator}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segment\-Locator}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Generic\-Locator}$<$ {\bf Auto\-Segment} $\ast$ $>$ {\bf Auto\-Segment\-Locator}}}\label{namespaceKatabatic_ace866cc8e09faf80f71a4087bb8e5870}
Shorthand for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} {\bf Hurricane} Generic Locator (locator with {\ttfamily unique\-\_\-ptr$<$$>$} like support). \hypertarget{namespaceKatabatic_a13ffc994c98e1a878e61a927de0509c8}{\index{Katabatic@{Katabatic}!Auto\-Segment\-Filter@{Auto\-Segment\-Filter}}
\index{Auto\-Segment\-Filter@{Auto\-Segment\-Filter}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segment\-Filter}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Generic\-Filter}$<$ {\bf Auto\-Segment} $\ast$ $>$ {\bf Auto\-Segment\-Filter}}}\label{namespaceKatabatic_a13ffc994c98e1a878e61a927de0509c8}
Shorthand for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} {\bf Hurricane} Generic Filter (filter with {\ttfamily unique\-\_\-ptr$<$$>$} like support). \hypertarget{namespaceKatabatic_ab68f9dfbbc79fd999773beef8561bc31}{\index{Katabatic@{Katabatic}!G\-Cells@{G\-Cells}}
\index{G\-Cells@{G\-Cells}!Katabatic@{Katabatic}}
\subsubsection[{G\-Cells}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Generic\-Collection}$<$ {\bf G\-Cell} $\ast$ $>$ {\bf G\-Cells}}}\label{namespaceKatabatic_ab68f9dfbbc79fd999773beef8561bc31}
\hyperlink{classKatabatic_1_1GCell}{G\-Cell} Collection with auto-\/pointer like support. \hypertarget{namespaceKatabatic_ae192ef170a0ad390902e435ac1e6796a}{\index{Katabatic@{Katabatic}!G\-Cell\-Locator@{G\-Cell\-Locator}}
\index{G\-Cell\-Locator@{G\-Cell\-Locator}!Katabatic@{Katabatic}}
\subsubsection[{G\-Cell\-Locator}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Generic\-Locator}$<$ {\bf G\-Cell} $\ast$ $>$ {\bf G\-Cell\-Locator}}}\label{namespaceKatabatic_ae192ef170a0ad390902e435ac1e6796a}
\hyperlink{classKatabatic_1_1GCell}{G\-Cell} Locator with auto-\/pointer like support. \hypertarget{namespaceKatabatic_a7d07e23d45818a2ae5f6881ce0ec7403}{\index{Katabatic@{Katabatic}!G\-Cell\-Filter@{G\-Cell\-Filter}}
\index{G\-Cell\-Filter@{G\-Cell\-Filter}!Katabatic@{Katabatic}}
\subsubsection[{G\-Cell\-Filter}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf Generic\-Filter}$<$ {\bf G\-Cell} $\ast$ $>$ {\bf G\-Cell\-Filter}}}\label{namespaceKatabatic_a7d07e23d45818a2ae5f6881ce0ec7403}
\hyperlink{classKatabatic_1_1GCell}{G\-Cell} Filter with auto-\/pointer like support.
\subsection{Enumeration Type Documentation}
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217}{\index{Katabatic@{Katabatic}!Function\-Flag@{Function\-Flag}}
\index{Function\-Flag@{Function\-Flag}!Katabatic@{Katabatic}}
\subsubsection[{Function\-Flag}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Function\-Flag}}}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217}
A set of flags to that can be passed to functions/methods througout all \hyperlink{namespaceKatabatic}{Katabatic}. \begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{Kb\-Open\-Session@{Kb\-Open\-Session}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Open\-Session@{Kb\-Open\-Session}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af314588109fcc5f5ee1c42e5fd4d0ed5}{Kb\-Open\-Session}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af314588109fcc5f5ee1c42e5fd4d0ed5}
}]Tells the function to open it's own \hyperlink{classKatabatic_1_1Session}{Session}, otherwise use the one that should already have been opened. \index{Kb\-Realignate@{Kb\-Realignate}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Realignate@{Kb\-Realignate}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a45a219697151531a23e997b11118e08a}{Kb\-Realignate}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a45a219697151531a23e997b11118e08a}
}]On \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} axis manipulation, force the realignment of all the segment on an aligned set, even is the axis of the canonical is already at the right coordinate. \index{Kb\-Native\-Constraints@{Kb\-Native\-Constraints}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Native\-Constraints@{Kb\-Native\-Constraints}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af1d61226371622b8063fe47c63cd9dff}{Kb\-Native\-Constraints}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af1d61226371622b8063fe47c63cd9dff}
}]Ignore user-\/defined constraints or terminal induced ones (for Auto\-Contacts anchored on terminals) and return the owning \hyperlink{classKatabatic_1_1GCell}{G\-Cell} alone. \index{Kb\-Force\-Move@{Kb\-Force\-Move}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Force\-Move@{Kb\-Force\-Move}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217acf76914f1ec05633965f0ac6b1c89959}{Kb\-Force\-Move}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217acf76914f1ec05633965f0ac6b1c89959}
}]Tells the function to force move, even if it is not needed. \index{Kb\-Horizontal@{Kb\-Horizontal}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Horizontal@{Kb\-Horizontal}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a1a9045673c5d3c30b067100f1440ae1b}{Kb\-Horizontal}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a1a9045673c5d3c30b067100f1440ae1b}
}]Request some action to be done in the horizontal direction. \index{Kb\-Vertical@{Kb\-Vertical}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Vertical@{Kb\-Vertical}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a284cad95203a27172838b09e396e3590}{Kb\-Vertical}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a284cad95203a27172838b09e396e3590}
}]Request some action to be done in the vertical direction. \index{Kb\-With\-Perpands@{Kb\-With\-Perpands}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-With\-Perpands@{Kb\-With\-Perpands}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217ae2d033c8f78b61468c827de8db5fe839}{Kb\-With\-Perpands}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217ae2d033c8f78b61468c827de8db5fe839}
}]Request that Auto\-Segments in perpandicular direction should be includeds. \index{Kb\-Source@{Kb\-Source}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Source@{Kb\-Source}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a8c8fd7a68cd428639057fbc6dbb8c46a}{Kb\-Source}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a8c8fd7a68cd428639057fbc6dbb8c46a}
}]Request Auto\-Segments anchored by their source anchor or that some operation has to be performed on the source. \index{Kb\-Target@{Kb\-Target}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Target@{Kb\-Target}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a041350b28d805a40d048fa0be9994a26}{Kb\-Target}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a041350b28d805a40d048fa0be9994a26}
}]Request Auto\-Segments anchored by their target anchor or that some operation has to be performed on the target. \index{Kb\-Warn\-On\-Error@{Kb\-Warn\-On\-Error}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Warn\-On\-Error@{Kb\-Warn\-On\-Error}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217aa5153b2cc25ebccca8616ce20ecd727a}{Kb\-Warn\-On\-Error}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217aa5153b2cc25ebccca8616ce20ecd727a}
}]Display a warning if something has gone wrong. \index{Kb\-Propagate@{Kb\-Propagate}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Propagate@{Kb\-Propagate}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a3f95c1f06fe0b58b44ccbc57d99f2a5d}{Kb\-Propagate}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a3f95c1f06fe0b58b44ccbc57d99f2a5d}
}]The action will affect all the segments on an aligned set. \index{Kb\-Use\-Above\-Layer@{Kb\-Use\-Above\-Layer}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Use\-Above\-Layer@{Kb\-Use\-Above\-Layer}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af756099f1bbe259dd1bf22067dc40eac}{Kb\-Use\-Above\-Layer}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217af756099f1bbe259dd1bf22067dc40eac}
}]Request/tell the a above layer has been used. \index{Kb\-Use\-Below\-Layer@{Kb\-Use\-Below\-Layer}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Use\-Below\-Layer@{Kb\-Use\-Below\-Layer}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a41cbd981337678e042354f340bfae25d}{Kb\-Use\-Below\-Layer}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a41cbd981337678e042354f340bfae25d}
}]Request/tell the a below layer has been used. \index{Kb\-Dogleg\-On\-Left@{Kb\-Dogleg\-On\-Left}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Dogleg\-On\-Left@{Kb\-Dogleg\-On\-Left}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a67bb7c53bbbc73a0e2d1f3f3e16ab679}{Kb\-Dogleg\-On\-Left}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a67bb7c53bbbc73a0e2d1f3f3e16ab679}
}]The dogleg has occured on the left {\itshape of something} \index{Kb\-Dogleg\-On\-Right@{Kb\-Dogleg\-On\-Right}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Dogleg\-On\-Right@{Kb\-Dogleg\-On\-Right}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217afe7fcb4c332f36e477433169b3d3f515}{Kb\-Dogleg\-On\-Right}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217afe7fcb4c332f36e477433169b3d3f515}
}]The dogleg has occured on the right {\itshape of something} \index{Kb\-Half\-Slacken@{Kb\-Half\-Slacken}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Kb\-Half\-Slacken@{Kb\-Half\-Slacken}}\item[{\em
\hypertarget{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a1d6ccf82d04758a0922270d4f469066a}{Kb\-Half\-Slacken}\label{namespaceKatabatic_a2af2ad6b6441614038caf59d04b3b217a1d6ccf82d04758a0922270d4f469066a}
}]For \hyperlink{classKatabatic_1_1AutoSegment_a1fbc0adb4c0b14632edc7c55f028cd4b}{Auto\-Segment\-::slacken()}, change the overconstrained limit from 10 tracks down to 3 (hard-\/wired). \end{description}
\end{Desc}
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cda}{\index{Katabatic@{Katabatic}!Engine\-State@{Engine\-State}}
\index{Engine\-State@{Engine\-State}!Katabatic@{Katabatic}}
\subsubsection[{Engine\-State}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Engine\-State}}}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cda}
Describe the current state of the \hyperlink{classKatabatic_1_1KatabaticEngine}{Katabatic\-Engine}. \begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{Engine\-Creation@{Engine\-Creation}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Engine\-Creation@{Engine\-Creation}}\item[{\em
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaa8bae41ad2fa29aaa5020b985b13416e0}{Engine\-Creation}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaa8bae41ad2fa29aaa5020b985b13416e0}
}]The tool is created, but still in the {\ttfamily \-\_\-post\-Create} stage. \index{Engine\-Global\-Loaded@{Engine\-Global\-Loaded}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Engine\-Global\-Loaded@{Engine\-Global\-Loaded}}\item[{\em
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaa5e262eba2c323c8ab5365b5e1364fc1e}{Engine\-Global\-Loaded}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaa5e262eba2c323c8ab5365b5e1364fc1e}
}]The global routing has been loaded from Knik. \index{Engine\-Active@{Engine\-Active}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Engine\-Active@{Engine\-Active}}\item[{\em
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaad4f7e86648b59223202a64bde4eda4c7}{Engine\-Active}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaad4f7e86648b59223202a64bde4eda4c7}
}]The Engine is in normal running mode (routing ordinary wires). \index{Engine\-Driving@{Engine\-Driving}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Engine\-Driving@{Engine\-Driving}}\item[{\em
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaae21d68495c3c349ad351ba9692b40bd1}{Engine\-Driving}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaae21d68495c3c349ad351ba9692b40bd1}
}]The Engine is transforming the Auto\-Contact/\-Auto\-Segment into normal Contact/\-Segment (prior to tool deletion). \index{Engine\-Pre\-Destroying@{Engine\-Pre\-Destroying}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Engine\-Pre\-Destroying@{Engine\-Pre\-Destroying}}\item[{\em
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaafee0f47ec435d9c4e49b98a47683ad03}{Engine\-Pre\-Destroying}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaafee0f47ec435d9c4e49b98a47683ad03}
}]This state is used whenever the tool is destroyed without passing through the Engine\-Driving state. \index{Engine\-Gutted@{Engine\-Gutted}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Engine\-Gutted@{Engine\-Gutted}}\item[{\em
\hypertarget{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaafb5f961d4cad2bb9fbda71204061c877}{Engine\-Gutted}\label{namespaceKatabatic_ab9e409db5feff0bdbc85e90e2a029cdaafb5f961d4cad2bb9fbda71204061c877}
}]After the Engine\-Driving state, all the working structures are removed and the tool can no longer be used. It only awaits clean destruction. \end{description}
\end{Desc}
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24}{\index{Katabatic@{Katabatic}!Auto\-Contact\-Flag@{Auto\-Contact\-Flag}}
\index{Auto\-Contact\-Flag@{Auto\-Contact\-Flag}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Contact\-Flag}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Auto\-Contact\-Flag}}}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24}
Set of flags to describe the internal state of an \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact}. \begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{Cnt\-Fixed@{Cnt\-Fixed}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-Fixed@{Cnt\-Fixed}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a66205741ac37bce922c730c95f6984af}{Cnt\-Fixed}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a66205741ac37bce922c730c95f6984af}
}]This contact cannot be moved. \index{Cnt\-Terminal@{Cnt\-Terminal}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-Terminal@{Cnt\-Terminal}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a59ca560e6a04e6401054626b8b8f74bc}{Cnt\-Terminal}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a59ca560e6a04e6401054626b8b8f74bc}
}]This contact is anchored on a terminal (\hyperlink{classKatabatic_1_1AutoContactTerminal}{Auto\-Contact\-Terminal}), {\bfseries must not be changed}. \index{Cnt\-Turn@{Cnt\-Turn}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-Turn@{Cnt\-Turn}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24aa0a37bdfa4c0097ebfb5f69e612fa57b}{Cnt\-Turn}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24aa0a37bdfa4c0097ebfb5f69e612fa57b}
}]The object true class is \hyperlink{classKatabatic_1_1AutoContactTurn}{Auto\-Contact\-Turn}, {\bfseries must not be changed}. \index{Cnt\-H\-Tee@{Cnt\-H\-Tee}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-H\-Tee@{Cnt\-H\-Tee}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24ad8d6114e340ad8064617cc3c7b5e62f3}{Cnt\-H\-Tee}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24ad8d6114e340ad8064617cc3c7b5e62f3}
}]The object true class is \hyperlink{classKatabatic_1_1AutoContactHTee}{Auto\-Contact\-H\-Tee}, {\bfseries must not be changed}. \index{Cnt\-V\-Tee@{Cnt\-V\-Tee}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-V\-Tee@{Cnt\-V\-Tee}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24ac8b5263851e6e160bff135cc6ecd45c5}{Cnt\-V\-Tee}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24ac8b5263851e6e160bff135cc6ecd45c5}
}]The object true class is \hyperlink{classKatabatic_1_1AutoContactVTee}{Auto\-Contact\-V\-Tee}, {\bfseries must not be changed}. \index{Cnt\-Invalidated@{Cnt\-Invalidated}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-Invalidated@{Cnt\-Invalidated}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a16ebc32170107fe230ddcc2dcbaab66f}{Cnt\-Invalidated}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a16ebc32170107fe230ddcc2dcbaab66f}
}]At least one \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} of this contact has been moved, the contact position must be recomputed (in the \hyperlink{classKatabatic_1_1Session}{Session} revalidation). \index{Cnt\-Invalidated\-Cache@{Cnt\-Invalidated\-Cache}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-Invalidated\-Cache@{Cnt\-Invalidated\-Cache}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a03218a60eff8f1960babe7e2a300301a}{Cnt\-Invalidated\-Cache}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a03218a60eff8f1960babe7e2a300301a}
}]At least one \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been broken or moved up, the connexity must be checked and possibly corrected (in \hyperlink{classKatabatic_1_1Session}{Session} revalidation). \index{Cnt\-In\-Creation\-Stage@{Cnt\-In\-Creation\-Stage}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-In\-Creation\-Stage@{Cnt\-In\-Creation\-Stage}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a803ca5191d4aba9d1f53aeec8d137359}{Cnt\-In\-Creation\-Stage}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24a803ca5191d4aba9d1f53aeec8d137359}
}]Sets only during the initial creation process. \index{Cnt\-Bad\-Topology@{Cnt\-Bad\-Topology}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Cnt\-Bad\-Topology@{Cnt\-Bad\-Topology}}\item[{\em
\hypertarget{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24abe577b4e6bc01e6a506a303ad8ccdf38}{Cnt\-Bad\-Topology}\label{namespaceKatabatic_a4950b7142b9024cae2693cd44bccdc24abe577b4e6bc01e6a506a303ad8ccdf38}
}]Something wrong has happened and the connexity of the \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} is no longer ensured (too much or too less Auto\-Segments, too wide span of \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} layers). \end{description}
\end{Desc}
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4}{\index{Katabatic@{Katabatic}!Auto\-Segment\-Flag@{Auto\-Segment\-Flag}}
\index{Auto\-Segment\-Flag@{Auto\-Segment\-Flag}!Katabatic@{Katabatic}}
\subsubsection[{Auto\-Segment\-Flag}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Auto\-Segment\-Flag}}}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4}
Set of flags to describe the internal state of an \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}. \begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{Seg\-Horizontal@{Seg\-Horizontal}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Horizontal@{Seg\-Horizontal}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a275eb973fc7a219eb34d2031309ff75c}{Seg\-Horizontal}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a275eb973fc7a219eb34d2031309ff75c}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} is associated to a {\bf Hurricane\-::\-Horizontal}, if not set, it is associated to a {\bf Hurricane\-::\-Vertical}. Set when the object is constructed. \index{Seg\-Fixed@{Seg\-Fixed}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Fixed@{Seg\-Fixed}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4aa291777ea80e37ea23e785870d8833ed}{Seg\-Fixed}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4aa291777ea80e37ea23e785870d8833ed}
}]The {\bf Hurricane\-::\-Segment} associated must/cannot be moved. \index{Seg\-Global@{Seg\-Global}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Global@{Seg\-Global}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a940d92cb98a61e671a94204701767868}{Seg\-Global}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a940d92cb98a61e671a94204701767868}
}]The \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} span between at least two G\-Cells (i.\-e. not fully enclosed in one). \index{Seg\-Weak\-Global@{Seg\-Weak\-Global}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Weak\-Global@{Seg\-Weak\-Global}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a16ef6f2b6b9e44559e41f04c652919ad}{Seg\-Weak\-Global}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a16ef6f2b6b9e44559e41f04c652919ad}
}]The \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} is part of an aligned set which contains at least a global. The global segment is itself tagged as weak global. \index{Seg\-Canonical@{Seg\-Canonical}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Canonical@{Seg\-Canonical}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a296b371b45ade66cd1d44bc8898e64d9}{Seg\-Canonical}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a296b371b45ade66cd1d44bc8898e64d9}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} is the designated representant of a set of aligned \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment}. \index{Seg\-Bipoint@{Seg\-Bipoint}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Bipoint@{Seg\-Bipoint}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a2d969cfff8aa7da1ac3486924f4786d2}{Seg\-Bipoint}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a2d969cfff8aa7da1ac3486924f4786d2}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} is a straight wire between two terminal \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact}. \index{Seg\-Dogleg@{Seg\-Dogleg}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Dogleg@{Seg\-Dogleg}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ab3a62f799073ef374df7aaa26514c09b}{Seg\-Dogleg}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ab3a62f799073ef374df7aaa26514c09b}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been created as the perpandicular part of a dogleg. \index{Seg\-Strap@{Seg\-Strap}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Strap@{Seg\-Strap}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a8c676eccde69f8a431ffaf2ffcae7209}{Seg\-Strap}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a8c676eccde69f8a431ffaf2ffcae7209}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been created to to reconnect parts of an \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} after slackening. \index{Seg\-Source\-Top@{Seg\-Source\-Top}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Source\-Top@{Seg\-Source\-Top}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ae5f763897c8e6221dcc8177816c72b33}{Seg\-Source\-Top}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ae5f763897c8e6221dcc8177816c72b33}
}]The source contact of this segment is connected to the {\itshape top} layer. \index{Seg\-Source\-Bottom@{Seg\-Source\-Bottom}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Source\-Bottom@{Seg\-Source\-Bottom}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a29f1952fe978a9fdd1902a6fcd085b44}{Seg\-Source\-Bottom}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a29f1952fe978a9fdd1902a6fcd085b44}
}]The source contact of this segment is connected to the {\itshape bottom} layer. \index{Seg\-Target\-Top@{Seg\-Target\-Top}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Target\-Top@{Seg\-Target\-Top}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a100b7ff78619133970733fedbb34ffa8}{Seg\-Target\-Top}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a100b7ff78619133970733fedbb34ffa8}
}]The target contact of this segment is connected to the {\itshape top} layer. \index{Seg\-Target\-Bottom@{Seg\-Target\-Bottom}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Target\-Bottom@{Seg\-Target\-Bottom}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ae600c6015187dddac3860fcc008a2213}{Seg\-Target\-Bottom}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ae600c6015187dddac3860fcc008a2213}
}]The target contact of this segment is connected to the {\itshape bottom} layer. \index{Seg\-Is\-Reduced@{Seg\-Is\-Reduced}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Is\-Reduced@{Seg\-Is\-Reduced}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4af4dd1db46475e4a16555fb6978a85580}{Seg\-Is\-Reduced}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4af4dd1db46475e4a16555fb6978a85580}
}]This segment is the perpandicular part of a dogleg which will use the {\itshape same} layer as the parallels. \index{Seg\-Layer\-Change@{Seg\-Layer\-Change}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Layer\-Change@{Seg\-Layer\-Change}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4afc9fc027fe8f457520c3fe6fb1144b2b}{Seg\-Layer\-Change}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4afc9fc027fe8f457520c3fe6fb1144b2b}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been created to to reconnect parts of an \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} after a layer change. \index{Seg\-Strong\-Terminal@{Seg\-Strong\-Terminal}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Strong\-Terminal@{Seg\-Strong\-Terminal}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a93251a6b8197685e2aaf77a760851557}{Seg\-Strong\-Terminal}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a93251a6b8197685e2aaf77a760851557}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} directly connected to a terminal. \index{Seg\-Weak\-Terminal1@{Seg\-Weak\-Terminal1}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Weak\-Terminal1@{Seg\-Weak\-Terminal1}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a7b3e09b8ab4cf676fd308535d7fba892}{Seg\-Weak\-Terminal1}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a7b3e09b8ab4cf676fd308535d7fba892}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} indirectly connected to a terminal with medium strength. \index{Seg\-Weak\-Terminal2@{Seg\-Weak\-Terminal2}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Weak\-Terminal2@{Seg\-Weak\-Terminal2}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a32f77fa2da27348bcfc294a039efd766}{Seg\-Weak\-Terminal2}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a32f77fa2da27348bcfc294a039efd766}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} indirectly connected to a terminal with weak strength. \index{Seg\-Not\-Source\-Aligned@{Seg\-Not\-Source\-Aligned}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Not\-Source\-Aligned@{Seg\-Not\-Source\-Aligned}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a286b96fc8ab2377a2caf92c82352b0c8}{Seg\-Not\-Source\-Aligned}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a286b96fc8ab2377a2caf92c82352b0c8}
}]This source contact of the segment is not the aligned part of a tee ({\ttfamily h1} or {\ttfamily h2} for a {\ttfamily H\-Tee}, {\ttfamily v1} or {\ttfamily v2} for a {\ttfamily V\-Tee}).
\begin{DoxySeeAlso}{See Also}
Auto\-Segment\-Flag\-::\-Seg\-Not\-Aligned
\end{DoxySeeAlso}
\index{Seg\-Not\-Target\-Aligned@{Seg\-Not\-Target\-Aligned}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Not\-Target\-Aligned@{Seg\-Not\-Target\-Aligned}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac5042810c9268798def84444d31968ea}{Seg\-Not\-Target\-Aligned}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac5042810c9268798def84444d31968ea}
}]This target contact of the segment is not the aligned part of a tee ({\ttfamily h1} or {\ttfamily h2} for a {\ttfamily H\-Tee}, {\ttfamily v1} or {\ttfamily v2} for a {\ttfamily V\-Tee}).
\begin{DoxySeeAlso}{See Also}
Auto\-Segment\-Flag\-::\-Seg\-Not\-Aligned
\end{DoxySeeAlso}
\index{Seg\-Slackened@{Seg\-Slackened}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Slackened@{Seg\-Slackened}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac47f838c52b3b33b1150eb53133c2383}{Seg\-Slackened}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac47f838c52b3b33b1150eb53133c2383}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been slackened, that is freed from any constraints from source or target through the insertion of straps. \index{Seg\-Axis\-Set@{Seg\-Axis\-Set}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Axis\-Set@{Seg\-Axis\-Set}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a86d22dbc8fbc045a1e12e25ba357e1d1}{Seg\-Axis\-Set}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a86d22dbc8fbc045a1e12e25ba357e1d1}
}]This \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been explicitly positionned at least once. \index{Seg\-Invalidated@{Seg\-Invalidated}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Invalidated@{Seg\-Invalidated}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a3c1d76fecee6a8bd5e12ce3fec013827}{Seg\-Invalidated}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a3c1d76fecee6a8bd5e12ce3fec013827}
}]This position or topology of this \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has been changed, needing a revalidation. \index{Seg\-Invalidated\-Layer@{Seg\-Invalidated\-Layer}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Invalidated\-Layer@{Seg\-Invalidated\-Layer}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a11c86dd3185eb251b2f3ce536cc2ab34}{Seg\-Invalidated\-Layer}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a11c86dd3185eb251b2f3ce536cc2ab34}
}]The segment has been chenged of layer, but the source \& target \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} have not been topologicaly checked yet. This flag {\bfseries must} be used in whith Auto\-Segment\-Flag\-::\-Seg\-Invalidated. \index{Seg\-Created@{Seg\-Created}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Created@{Seg\-Created}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a01513b74d37a8721370cf7b91fb419ad}{Seg\-Created}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a01513b74d37a8721370cf7b91fb419ad}
}]The \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} has just been created. This flag is set only from the contruction of the object until is {\itshape first} revalidation. Used to disable some tests that cannot be satisfied initially. \index{Seg\-Weak\-Terminal@{Seg\-Weak\-Terminal}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Weak\-Terminal@{Seg\-Weak\-Terminal}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a419e7722198b077c1f71d6c47e2fc2ab}{Seg\-Weak\-Terminal}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a419e7722198b077c1f71d6c47e2fc2ab}
}]A mask composed of\-:
\begin{DoxyItemize}
\item \hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a93251a6b8197685e2aaf77a760851557}{Katabatic\-::\-Seg\-Strong\-Terminal}
\item \hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a7b3e09b8ab4cf676fd308535d7fba892}{Katabatic\-::\-Seg\-Weak\-Terminal1}
\item \hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a32f77fa2da27348bcfc294a039efd766}{Katabatic\-::\-Seg\-Weak\-Terminal2}
\end{DoxyItemize}\index{Seg\-Not\-Aligned@{Seg\-Not\-Aligned}!Katabatic@{Katabatic}}\index{Katabatic@{Katabatic}!Seg\-Not\-Aligned@{Seg\-Not\-Aligned}}\item[{\em
\hypertarget{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a637e0426170a532feac45548e009325d}{Seg\-Not\-Aligned}\label{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a637e0426170a532feac45548e009325d}
}]A mask composed of\-:
\begin{DoxyItemize}
\item \hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4a286b96fc8ab2377a2caf92c82352b0c8}{Katabatic\-::\-Seg\-Not\-Source\-Aligned}
\item \hyperlink{namespaceKatabatic_a94585537ee1724ea9315578ec54380f4ac5042810c9268798def84444d31968ea}{Katabatic\-::\-Seg\-Not\-Target\-Aligned}
\end{DoxyItemize}
This mask is a quick way to know if a segment is {\bfseries not} part of an aligned set. It means that the segment is, on both ends, either connected to a terminal, a turn {\itshape or the stem part of a tee}. \end{description}
\end{Desc}