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

233 lines
28 KiB
TeX
Raw Normal View History

Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\hypertarget{classKite_1_1SegmentAction}{\subsection{Segment\-Action Class Reference}
\label{classKite_1_1SegmentAction}\index{Segment\-Action@{Segment\-Action}}
}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
Store request for an event to be generated on a \hyperlink{classKite_1_1TrackElement}{Track\-Element}.
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\subsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
enum \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Type} \{ \\*
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aacd3ef9d889b306ca7e7bdcd37ba659a}{Self} = (1$<$$<$ 0),
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\\*
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a75f0c3176be2226dfe8ad164a0a034a2}{Other} = (1$<$$<$ 1),
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\\*
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a02330ea306385a34162a1e620a1c37df}{Perpandicular} = (1$<$$<$ 2),
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\\*
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a8c1f14f07c9eedcbbb2cc61988030646}{Insert} = (1$<$$<$ 3),
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\\*
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a08900dc237aef7e4a7f50d2ba1ffd748}{Ripup} = (1$<$$<$ 4),
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a4fab9c042ba690bdb62d3c34eab8472d}{Riped\-By\-Local} = (1$<$$<$ 5),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a9e16316a13899c2e02dd49cf2fb6e91f}{Reset\-Ripup} = (1$<$$<$ 6),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a6c00c46010d69247a3edc18b70d700fa}{To\-Ripup\-Limit} = (1$<$$<$ 7)
, \\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a46c4ca7a69b5eae786be28f75523b78b}{Axis\-Hint} = (1$<$$<$ 9),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a4fe6b9a3b3816492b9a99ab6689c4b20}{Packing\-Mode} = (1$<$$<$10),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a8b27ea2f99b2e6446eac77626aef0711}{To\-State} = (1$<$$<$11),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7adb9a006587bc8a635ffdd034c53a546f}{Event\-Level1} = (1$<$$<$12),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a5bad02627a87d3e38d5812363e46d7b1}{Event\-Level2} = (1$<$$<$13),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a11ef388ea422168a9c79fd9b4d81ea34}{Event\-Level3} = (1$<$$<$14),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ab8346062d5bbccb98893c4675b8d5098}{Event\-Level4} = (1$<$$<$15),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a432d5152211bf70a2d561b8bda34c9e0}{Event\-Level5} = (1$<$$<$16),
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a930d0718b2afc37983ffe708f8261b19}{Self\-Insert} = Self $|$\-Insert,
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a837e07a8b4101cff32018683072f2d78}{Self\-Ripup} = Self $|$\-Ripup,
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a85fd77114c99a0827e08de2fc6a53ed7}{Self\-Ripup\-Perpand} = Self $|$\-Ripup$|$\-Perpandicular,
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ae30745ee276038ba4d7b5f92d80f3715}{Self\-Ripup\-Perpand\-With\-Axis\-Hint} = Self $|$\-Ripup$|$\-Perpandicular$|$\-Event\-Level4$|$\-Axis\-Hint,
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a22374bab829fac7d12af4784d80eeb6e}{Other\-Ripup} = Other$|$\-Ripup,
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ad9caf9375b714a403e4af8a142cf9991}{Other\-Ripup\-Perpand\-And\-Push\-Aside} = Other$|$\-Ripup$|$\-Perpandicular$|$\-Event\-Level3$|$\-Axis\-Hint,
\\*
\hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aed50f579a9e6b7ac698b2edf1a5da5c8}{Other\-Ripup\-Perpand\-And\-Packing} = Other$|$\-Ripup$|$\-Perpandicular$|$\-Event\-Level4$|$\-Packing\-Mode
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\}
\end{DoxyCompactItemize}
\subsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\hyperlink{classKite_1_1SegmentAction_acbeca58f8327b69a540628f299d5bd35}{Segment\-Action} (\hyperlink{classKite_1_1TrackElement}{Track\-Element} $\ast$, unsigned int type, {\bf Db\-U\-::\-Unit} axis\-Hint=0, unsigned int to\-State=0)
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\hyperlink{classKite_1_1TrackElement}{Track\-Element} $\ast$ \hyperlink{classKite_1_1SegmentAction_ad2d369e354ca1f9ff118851da69c7efc}{get\-Segment} () const
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink{classKite_1_1SegmentAction_a8deb0c124963cedd374717099ff5bd22}{get\-Type} () const
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
void \hyperlink{classKite_1_1SegmentAction_a8dc7cdf5f643a856fa5208bcfd1f8342}{set\-Axis\-Hint} ({\bf Db\-U\-::\-Unit})
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
unsigned int \hyperlink{classKite_1_1SegmentAction_a4e1f44319a9a0a413fe1413a87ec78bd}{set\-Flag} (unsigned int)
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
bool \hyperlink{classKite_1_1SegmentAction_a324f17f0f5a09b76344eb2e003695d74}{do\-Action} (\hyperlink{classKite_1_1RoutingEventQueue}{Routing\-Event\-Queue} \&)
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\end{DoxyCompactItemize}
\subsubsection{Detailed Description}
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
Store request for an event to be generated on a \hyperlink{classKite_1_1TrackElement}{Track\-Element}.
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
When an event on a \hyperlink{classKite_1_1TrackElement}{Kite\-::\-Track\-Element} is being processed (with the \hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm} helper), it may generate events on \hyperlink{classKite_1_1TrackElement}{Track\-Element} already placed and belonging either to the same net or other ones. Those events are not generated and queued immediatly but instead \hyperlink{classKite_1_1SegmentAction}{Segment\-Action}, requesting the event generation are created and stored into a simple vector in \hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm}. The last operation of the \hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm} object is to call the \hyperlink{classKite_1_1SegmentAction_a324f17f0f5a09b76344eb2e003695d74}{Segment\-Action\-::do\-Action()} method on all the action to actually generate and queue the events.
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\subsubsection{Member Enumeration Documentation}
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Type@{Type}}
\index{Type@{Type}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{Type}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Type}}}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}
Indicates the kind of action to be performed on the segment. In the following {\bfseries flags} and {\bfseries masks} descriptions, we uses the term {\itshape reference segment} for the \hyperlink{classKite_1_1TrackElement}{Track\-Element} which is associated with the currently processed \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} (also referenced in \hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm}).
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
Here is the list of the availables actions that can be performed when (re)scheduling a \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}. It is here that we uses the \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} level feature to perform a local reordering of the top of the queue. Reordering is used to allows perpandiculars to be routed {\itshape before} the reference segment (instead of after) or {\itshape other} segments in conflict.
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\begin{DoxyItemize}
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a930d0718b2afc37983ffe708f8261b19}{Segment\-Action\-::\-Self\-Insert}\par
{\bfseries Action\-:} The reference segment is to be inserted in a \hyperlink{classKite_1_1Track}{Track} (placed).\par
{\bfseries Event Level\-:} Unchanged.
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a837e07a8b4101cff32018683072f2d78}{Segment\-Action\-::\-Self\-Ripup}\par
{\bfseries Action\-:} The reference segment is to be ripped up.\par
{\bfseries Event Level\-:} Unchanged.
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a85fd77114c99a0827e08de2fc6a53ed7}{Segment\-Action\-::\-Self\-Ripup\-Perpand}\par
{\bfseries Action\-:} Ripup a segment which is a perpandicular to the reference segment. Ordering considerations\-: this perpandicular will be put back into the \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} queue with a lower level (priority) than the reference segment, so it will be processed again {\itshape after} the reference segment.\par
{\bfseries Event Level\-:} Unchanged.
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ae30745ee276038ba4d7b5f92d80f3715}{Segment\-Action\-::\-Self\-Ripup\-Perpand\-With\-Axis\-Hint}\par
{\bfseries Action\-:} Ripup a segment which is a perpandicular to the reference segment, supplies an axis hint and put it back into the \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} queue so that it will be processed {\itshape before} the reference segment.\par
{\bfseries Event Level\-:} Increased to \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ab8346062d5bbccb98893c4675b8d5098}{Segment\-Action\-::\-Event\-Level4}.
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a22374bab829fac7d12af4784d80eeb6e}{Segment\-Action\-::\-Other\-Ripup}\par
{\bfseries Action\-:} Ripping up a segment from another net and in the same direction as the reference segment.\par
{\bfseries Event Level\-:} Unchanged.
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ad9caf9375b714a403e4af8a142cf9991}{Segment\-Action\-::\-Other\-Ripup\-Perpand\-And\-Push\-Aside}\par
{\bfseries Action\-:} Ripping up a segment from another net and in perpandicular direction. The level is elevated so it's priority is greater than the reference segment this it will be reprocessed first. An axis hint is also supplied in order to make room for the reference segment.\par
{\bfseries Event Level\-:} Increased to \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a11ef388ea422168a9c79fd9b4d81ea34}{Segment\-Action\-::\-Event\-Level3}.
\item \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aed50f579a9e6b7ac698b2edf1a5da5c8}{Segment\-Action\-::\-Other\-Ripup\-Perpand\-And\-Packing}\par
{\bfseries Action\-:} Ripping up a segment from another net and in perpandicular direction. The level is elevated so it's priority is greater than the reference segment this it will be reprocessed first. The generated event is in packing mode only.\par
{\bfseries Event Level\-:} Increased to \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ab8346062d5bbccb98893c4675b8d5098}{Segment\-Action\-::\-Event\-Level4}.
\end{DoxyItemize}\begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{Self@{Self}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Self@{Self}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aacd3ef9d889b306ca7e7bdcd37ba659a}{Self}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aacd3ef9d889b306ca7e7bdcd37ba659a}
}]{\bfseries \mbox{[}Flag\mbox{]}} The segment associated to the action is the reference segment {\itshape or segments from the same net}. \index{Other@{Other}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Other@{Other}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a75f0c3176be2226dfe8ad164a0a034a2}{Other}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a75f0c3176be2226dfe8ad164a0a034a2}
}]{\bfseries \mbox{[}Flag\mbox{]}} The segment associated to the action is {\bfseries not} from the same net as the reference segment. \index{Perpandicular@{Perpandicular}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Perpandicular@{Perpandicular}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a02330ea306385a34162a1e620a1c37df}{Perpandicular}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a02330ea306385a34162a1e620a1c37df}
}]{\bfseries \mbox{[}Flag\mbox{]}} The action concern a perpandicular to the reference segment. \index{Insert@{Insert}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Insert@{Insert}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a8c1f14f07c9eedcbbb2cc61988030646}{Insert}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a8c1f14f07c9eedcbbb2cc61988030646}
}]{\bfseries \mbox{[}Flag\mbox{]}} Request that the segment is to be inserted in the given track. It is the task of \hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm} to determine that there is sufficent space to do so. \index{Ripup@{Ripup}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Ripup@{Ripup}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a08900dc237aef7e4a7f50d2ba1ffd748}{Ripup}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a08900dc237aef7e4a7f50d2ba1ffd748}
}]{\bfseries \mbox{[}Flag\mbox{]}} Request that the segment is to be ripped up. \index{Riped\-By\-Local@{Riped\-By\-Local}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Riped\-By\-Local@{Riped\-By\-Local}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a4fab9c042ba690bdb62d3c34eab8472d}{Riped\-By\-Local}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a4fab9c042ba690bdb62d3c34eab8472d}
}]{\bfseries \mbox{[}Flag\mbox{]}} Indicate that the segment has been ripped up by a local one. \index{Reset\-Ripup@{Reset\-Ripup}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Reset\-Ripup@{Reset\-Ripup}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a9e16316a13899c2e02dd49cf2fb6e91f}{Reset\-Ripup}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a9e16316a13899c2e02dd49cf2fb6e91f}
}]{\bfseries \mbox{[}Flag\mbox{]}} The ripup count is to be reset. \index{To\-Ripup\-Limit@{To\-Ripup\-Limit}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!To\-Ripup\-Limit@{To\-Ripup\-Limit}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a6c00c46010d69247a3edc18b70d700fa}{To\-Ripup\-Limit}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a6c00c46010d69247a3edc18b70d700fa}
}]{\bfseries \mbox{[}Flag\mbox{]}} The ripup count is directly increased to the ripup limit, triggering a state change the next time the segment will be processed. \index{Axis\-Hint@{Axis\-Hint}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Axis\-Hint@{Axis\-Hint}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a46c4ca7a69b5eae786be28f75523b78b}{Axis\-Hint}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a46c4ca7a69b5eae786be28f75523b78b}
}]{\bfseries \mbox{[}Flag\mbox{]}} An axis hint has been supplied, and is to be passed to the generated \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}. \index{Packing\-Mode@{Packing\-Mode}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Packing\-Mode@{Packing\-Mode}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a4fe6b9a3b3816492b9a99ab6689c4b20}{Packing\-Mode}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a4fe6b9a3b3816492b9a99ab6689c4b20}
}]{\bfseries \mbox{[}Flag\mbox{]}} Whether the \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} should be processed in {\itshape packing} mode or {\itshape negociated} mode (transmitted to the \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event}). \index{To\-State@{To\-State}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!To\-State@{To\-State}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a8b27ea2f99b2e6446eac77626aef0711}{To\-State}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a8b27ea2f99b2e6446eac77626aef0711}
}]{\bfseries \mbox{[}Flag\mbox{]}} Force the change of state of the \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} (i.\-e. \hyperlink{classKite_1_1DataNegociate}{Data\-Negociate}). Normally the state change is done through the increase of the ripup count in \hyperlink{classKite_1_1DataNegociate}{Data\-Negociate}. \index{Event\-Level1@{Event\-Level1}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Event\-Level1@{Event\-Level1}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7adb9a006587bc8a635ffdd034c53a546f}{Event\-Level1}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7adb9a006587bc8a635ffdd034c53a546f}
}]{\bfseries \mbox{[}Flag\mbox{]}} Increase the level to {\itshape at least} {\bfseries 1}. \index{Event\-Level2@{Event\-Level2}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Event\-Level2@{Event\-Level2}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a5bad02627a87d3e38d5812363e46d7b1}{Event\-Level2}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a5bad02627a87d3e38d5812363e46d7b1}
}]{\bfseries \mbox{[}Flag\mbox{]}} Increase the level to {\itshape at least} {\bfseries 2}. \index{Event\-Level3@{Event\-Level3}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Event\-Level3@{Event\-Level3}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a11ef388ea422168a9c79fd9b4d81ea34}{Event\-Level3}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a11ef388ea422168a9c79fd9b4d81ea34}
}]{\bfseries \mbox{[}Flag\mbox{]}} Increase the level to {\itshape at least} {\bfseries 3}. \index{Event\-Level4@{Event\-Level4}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Event\-Level4@{Event\-Level4}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ab8346062d5bbccb98893c4675b8d5098}{Event\-Level4}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ab8346062d5bbccb98893c4675b8d5098}
}]{\bfseries \mbox{[}Flag\mbox{]}} Increase the level to {\itshape at least} {\bfseries 4}. \index{Event\-Level5@{Event\-Level5}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Event\-Level5@{Event\-Level5}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a432d5152211bf70a2d561b8bda34c9e0}{Event\-Level5}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a432d5152211bf70a2d561b8bda34c9e0}
}]{\bfseries \mbox{[}Flag\mbox{]}} Increase the level to {\itshape at least} {\bfseries 5}. \index{Self\-Insert@{Self\-Insert}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Self\-Insert@{Self\-Insert}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a930d0718b2afc37983ffe708f8261b19}{Self\-Insert}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a930d0718b2afc37983ffe708f8261b19}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \index{Self\-Ripup@{Self\-Ripup}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Self\-Ripup@{Self\-Ripup}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a837e07a8b4101cff32018683072f2d78}{Self\-Ripup}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a837e07a8b4101cff32018683072f2d78}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \index{Self\-Ripup\-Perpand@{Self\-Ripup\-Perpand}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Self\-Ripup\-Perpand@{Self\-Ripup\-Perpand}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a85fd77114c99a0827e08de2fc6a53ed7}{Self\-Ripup\-Perpand}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a85fd77114c99a0827e08de2fc6a53ed7}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \index{Self\-Ripup\-Perpand\-With\-Axis\-Hint@{Self\-Ripup\-Perpand\-With\-Axis\-Hint}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Self\-Ripup\-Perpand\-With\-Axis\-Hint@{Self\-Ripup\-Perpand\-With\-Axis\-Hint}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ae30745ee276038ba4d7b5f92d80f3715}{Self\-Ripup\-Perpand\-With\-Axis\-Hint}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ae30745ee276038ba4d7b5f92d80f3715}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \index{Other\-Ripup@{Other\-Ripup}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Other\-Ripup@{Other\-Ripup}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a22374bab829fac7d12af4784d80eeb6e}{Other\-Ripup}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7a22374bab829fac7d12af4784d80eeb6e}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \index{Other\-Ripup\-Perpand\-And\-Push\-Aside@{Other\-Ripup\-Perpand\-And\-Push\-Aside}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Other\-Ripup\-Perpand\-And\-Push\-Aside@{Other\-Ripup\-Perpand\-And\-Push\-Aside}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ad9caf9375b714a403e4af8a142cf9991}{Other\-Ripup\-Perpand\-And\-Push\-Aside}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7ad9caf9375b714a403e4af8a142cf9991}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \index{Other\-Ripup\-Perpand\-And\-Packing@{Other\-Ripup\-Perpand\-And\-Packing}!Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}}\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Other\-Ripup\-Perpand\-And\-Packing@{Other\-Ripup\-Perpand\-And\-Packing}}\item[{\em
\hypertarget{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aed50f579a9e6b7ac698b2edf1a5da5c8}{Other\-Ripup\-Perpand\-And\-Packing}\label{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7aed50f579a9e6b7ac698b2edf1a5da5c8}
}]{\bfseries \mbox{[}Mask\mbox{]}}, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \end{description}
\end{Desc}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\subsubsection{Constructor \& Destructor Documentation}
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\hypertarget{classKite_1_1SegmentAction_acbeca58f8327b69a540628f299d5bd35}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!Segment\-Action@{Segment\-Action}}
\index{Segment\-Action@{Segment\-Action}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{Segment\-Action}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Segment\-Action} (
\begin{DoxyParamCaption}
\item[{{\bf Track\-Element} $\ast$}]{segment, }
\item[{unsigned int}]{type, }
\item[{{\bf Db\-U\-::\-Unit}}]{axis\-Hint = {\ttfamily 0}, }
\item[{unsigned int}]{to\-State = {\ttfamily 0}}
\end{DoxyParamCaption}
)}}\label{classKite_1_1SegmentAction_acbeca58f8327b69a540628f299d5bd35}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\begin{DoxyParams}{Parameters}
{\em segment} & On what the action is to be performed. \\
\hline
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
{\em type} & Defines the type of action, see \hyperlink{classKite_1_1SegmentAction_a1d1cfd8ffb84e947f82999c682b666a7}{Segment\-Action\-::\-Type}. \\
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hline
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
{\em axis\-Hint} & Specifies a preferred axis. \\
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hline
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
{\em to\-State} & The \hyperlink{classKite_1_1DataNegociate_ab7ccb6fc1f298728995250a3bbcf18c7}{Data\-Negociate\-::\-Slack\-State} into which the segment is to be set.\\
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\hline
\end{DoxyParams}
Create segment action.
\subsubsection{Member Function Documentation}
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
\hypertarget{classKite_1_1SegmentAction_ad2d369e354ca1f9ff118851da69c7efc}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!get\-Segment@{get\-Segment}}
\index{get\-Segment@{get\-Segment}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{get\-Segment}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Track\-Element} $\ast$ get\-Segment (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1SegmentAction_ad2d369e354ca1f9ff118851da69c7efc}
{\bfseries Returns\-:} The associated {\ttfamily segment}. \hypertarget{classKite_1_1SegmentAction_a8deb0c124963cedd374717099ff5bd22}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!get\-Type@{get\-Type}}
\index{get\-Type@{get\-Type}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{get\-Type}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Segment\-Action\-::\-Type} get\-Type (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1SegmentAction_a8deb0c124963cedd374717099ff5bd22}
{\bfseries Returns\-:} The action to be performed. \hypertarget{classKite_1_1SegmentAction_a8dc7cdf5f643a856fa5208bcfd1f8342}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!set\-Axis\-Hint@{set\-Axis\-Hint}}
\index{set\-Axis\-Hint@{set\-Axis\-Hint}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{set\-Axis\-Hint}]{\setlength{\rightskip}{0pt plus 5cm}void set\-Axis\-Hint (
\begin{DoxyParamCaption}
\item[{{\bf Db\-U\-::\-Unit}}]{axis}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1SegmentAction_a8dc7cdf5f643a856fa5208bcfd1f8342}
The axis preferred position to be transmitted to the generated event. The transmition will be effective {\itshape only} if the Segment\-Action\-::\-Type\-::\-Axis\-Hint flag is set. \hypertarget{classKite_1_1SegmentAction_a4e1f44319a9a0a413fe1413a87ec78bd}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!set\-Flag@{set\-Flag}}
\index{set\-Flag@{set\-Flag}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{set\-Flag}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int set\-Flag (
\begin{DoxyParamCaption}
\item[{unsigned int}]{flags}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{classKite_1_1SegmentAction_a4e1f44319a9a0a413fe1413a87ec78bd}
Allow to change the action type by indivually setting up the flags. \hypertarget{classKite_1_1SegmentAction_a324f17f0f5a09b76344eb2e003695d74}{\index{Kite\-::\-Segment\-Action@{Kite\-::\-Segment\-Action}!do\-Action@{do\-Action}}
\index{do\-Action@{do\-Action}!Kite::SegmentAction@{Kite\-::\-Segment\-Action}}
\paragraph[{do\-Action}]{\setlength{\rightskip}{0pt plus 5cm}void do\-Action (
\begin{DoxyParamCaption}
\item[{{\bf Routing\-Event\-Queue} \&}]{queue}
\end{DoxyParamCaption}
)}}\label{classKite_1_1SegmentAction_a324f17f0f5a09b76344eb2e003695d74}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
Actually perform the action. That is, build and queue the appropriate event for the segment.
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
Segment\-Fsm.\-h\item
Segment\-Fsm.\-cpp\item
Segment\-Fsm.\-dox\end{DoxyCompactItemize}