196 lines
13 KiB
TeX
196 lines
13 KiB
TeX
\hypertarget{classKite_1_1TrackFixedSegment}{}\subsection{Track\+Fixed\+Segment Class Reference}
|
|
\label{classKite_1_1TrackFixedSegment}\index{Track\+Fixed\+Segment@{Track\+Fixed\+Segment}}
|
|
|
|
|
|
\hyperlink{classKite_1_1Track}{Track} elements for fixed wires.
|
|
|
|
|
|
|
|
|
|
Inheritance diagram for Track\+Fixed\+Segment\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=184pt]{classKite_1_1TrackFixedSegment__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
virtual bool \hyperlink{classKite_1_1TrackFixedSegment_a21b9cefd33ae22e4c2070ad441bdd30b}{is\+Horizontal} () const
|
|
\item
|
|
virtual bool \hyperlink{classKite_1_1TrackFixedSegment_abd54544ef1710ee4b67cfb021d73446c}{is\+Vertical} () const
|
|
\item
|
|
virtual bool \hyperlink{classKite_1_1TrackFixedSegment_afd7362b850709bed8b61c1aa22399f97}{is\+Fixed} () const
|
|
\item
|
|
virtual unsigned long \hyperlink{classKite_1_1TrackFixedSegment_afdedcef127ad2a3677a5b48d7d3453f3}{get\+Id} () const
|
|
\item
|
|
virtual unsigned int \hyperlink{classKite_1_1TrackFixedSegment_a0dd7cf705ace42c662c289955313b2e9}{get\+Direction} () const
|
|
\item
|
|
virtual \textbf{ Net} $\ast$ \hyperlink{classKite_1_1TrackFixedSegment_a692492374623a5c6096b2c4a51190359}{get\+Net} () const
|
|
\item
|
|
virtual const \textbf{ Layer} $\ast$ \hyperlink{classKite_1_1TrackFixedSegment_ab045567c4f529dca7790d66c17c3084f}{get\+Layer} () const
|
|
\item
|
|
virtual \hyperlink{classKite_1_1TrackElement}{Track\+Element} $\ast$ \hyperlink{classKite_1_1TrackFixedSegment_a010b7fc8801c5b88aefa4137cf85186d}{get\+Next} () const
|
|
\item
|
|
virtual \hyperlink{classKite_1_1TrackElement}{Track\+Element} $\ast$ \hyperlink{classKite_1_1TrackFixedSegment_a55d6115d84c11ad147f4c38fe372ea24}{get\+Previous} () const
|
|
\item
|
|
virtual \textbf{ Db\+U\+::\+Unit} \hyperlink{classKite_1_1TrackFixedSegment_ab5b5aaa5b318369feee6003dbad039c2}{get\+Axis} () const
|
|
\item
|
|
virtual \textbf{ Interval} \hyperlink{classKite_1_1TrackFixedSegment_a034711e2d3617ea848ef9f5a18255e10}{get\+Free\+Interval} () const
|
|
\end{DoxyCompactItemize}
|
|
\subsubsection*{Static Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
static \hyperlink{classKite_1_1TrackElement}{Track\+Element} $\ast$ \hyperlink{classKite_1_1TrackFixedSegment_a7b548c2078a8d380b37ca12a96aa979d}{create} (\hyperlink{classKite_1_1Track}{Kite\+::\+Track} $\ast$track, \textbf{ Segment} $\ast$segment)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\subsubsection{Detailed Description}
|
|
\hyperlink{classKite_1_1Track}{Track} elements for fixed wires.
|
|
|
|
A \hyperlink{classKite_1_1TrackFixedSegment}{Track\+Fixed\+Segment} is a segment that cannot be moved from the track. It can be associated to a true blockage Segment (recognised by the fact that their owner net is the {\itshape blockage} net), or to a segment from an ordinary net but which is locked into position. In the latter case, the owned net may reuse this portion of the track if it needs it.
|
|
|
|
In all cases, the blockage ratio of the G\+Cells underneath the segment are updated.
|
|
|
|
\subsubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a7b548c2078a8d380b37ca12a96aa979d}\label{classKite_1_1TrackFixedSegment_a7b548c2078a8d380b37ca12a96aa979d}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!create@{create}}
|
|
\index{create@{create}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{create()}{create()}}
|
|
{\footnotesize\ttfamily \hyperlink{classKite_1_1TrackSegment}{Track\+Segment} $\ast$ create (\begin{DoxyParamCaption}\item[{\hyperlink{classKite_1_1Track}{Kite\+::\+Track} $\ast$}]{track, }\item[{\textbf{ Segment} $\ast$}]{segment }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em segment} & The Hurricane Segment (blockage) to take into account. \\
|
|
\hline
|
|
{\em track} & A \hyperlink{classKite_1_1Track}{Track} into which insert the \hyperlink{classKite_1_1TrackFixedSegment}{Track\+Fixed\+Segment}. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
A \hyperlink{classKite_1_1TrackFixedSegment}{Track\+Fixed\+Segment} wrapped around a blockage Segment.
|
|
\end{DoxyReturn}
|
|
Public constructor to insert blockage inside a \hyperlink{classKite_1_1Track}{Track}. \mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a21b9cefd33ae22e4c2070ad441bdd30b}\label{classKite_1_1TrackFixedSegment_a21b9cefd33ae22e4c2070ad441bdd30b}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!is\+Horizontal@{is\+Horizontal}}
|
|
\index{is\+Horizontal@{is\+Horizontal}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{is\+Horizontal()}{isHorizontal()}}
|
|
{\footnotesize\ttfamily bool is\+Horizontal (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries See also\+:}~ \textbf{ Katabatic\+::\+Auto\+Segment\+::is\+Horizontal()}.
|
|
|
|
Implements \hyperlink{classKite_1_1TrackElement_a9d3db1f8a5aca58f8f54d291faebf873}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_abd54544ef1710ee4b67cfb021d73446c}\label{classKite_1_1TrackFixedSegment_abd54544ef1710ee4b67cfb021d73446c}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!is\+Vertical@{is\+Vertical}}
|
|
\index{is\+Vertical@{is\+Vertical}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{is\+Vertical()}{isVertical()}}
|
|
{\footnotesize\ttfamily bool is\+Vertical (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries See also\+:}~ \textbf{ Katabatic\+::\+Auto\+Segment\+::is\+Vertical()}.
|
|
|
|
Implements \hyperlink{classKite_1_1TrackElement_a6fa2bf0568a2b295dd7cd1f7207247d5}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_afd7362b850709bed8b61c1aa22399f97}\label{classKite_1_1TrackFixedSegment_afd7362b850709bed8b61c1aa22399f97}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!is\+Fixed@{is\+Fixed}}
|
|
\index{is\+Fixed@{is\+Fixed}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{is\+Fixed()}{isFixed()}}
|
|
{\footnotesize\ttfamily bool is\+Fixed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries See also\+:}~ \textbf{ Katabatic\+::\+Auto\+Segment\+::is\+Fixed()}.
|
|
|
|
Reimplemented from \hyperlink{classKite_1_1TrackElement_afd7362b850709bed8b61c1aa22399f97}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_afdedcef127ad2a3677a5b48d7d3453f3}\label{classKite_1_1TrackFixedSegment_afdedcef127ad2a3677a5b48d7d3453f3}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Id@{get\+Id}}
|
|
\index{get\+Id@{get\+Id}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Id()}{getId()}}
|
|
{\footnotesize\ttfamily unsigned long get\+Id (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
The {\ttfamily Id} of the supporting Auto\+Segment, if there is any. {\itshape Zero} otherwise.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Reimplemented from \hyperlink{classKite_1_1TrackElement_afdedcef127ad2a3677a5b48d7d3453f3}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a0dd7cf705ace42c662c289955313b2e9}\label{classKite_1_1TrackFixedSegment_a0dd7cf705ace42c662c289955313b2e9}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Direction@{get\+Direction}}
|
|
\index{get\+Direction@{get\+Direction}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Direction()}{getDirection()}}
|
|
{\footnotesize\ttfamily unsigned int get\+Direction (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
The direction of the supporting element (should match the preferred direction of the \hyperlink{classKite_1_1Track}{Track}).
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Implements \hyperlink{classKite_1_1TrackElement_ae35b78590ed6aa546b626ef95f28c533}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a692492374623a5c6096b2c4a51190359}\label{classKite_1_1TrackFixedSegment_a692492374623a5c6096b2c4a51190359}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Net@{get\+Net}}
|
|
\index{get\+Net@{get\+Net}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Net()}{getNet()}}
|
|
{\footnotesize\ttfamily \textbf{ Net} $\ast$ get\+Net (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The Net associated to the element (may be {\ttfamily N\+U\+LL}).
|
|
|
|
Implements \hyperlink{classKite_1_1TrackElement_a2b383a5b6f5028911a35e446a682dabd}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_ab045567c4f529dca7790d66c17c3084f}\label{classKite_1_1TrackFixedSegment_ab045567c4f529dca7790d66c17c3084f}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Layer@{get\+Layer}}
|
|
\index{get\+Layer@{get\+Layer}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Layer()}{getLayer()}}
|
|
{\footnotesize\ttfamily const \textbf{ Layer} $\ast$ get\+Layer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The Layer of the element (should match the one of the \hyperlink{classKite_1_1Track}{Track}).
|
|
|
|
Implements \hyperlink{classKite_1_1TrackElement_ad96c66549598873bf68c2e18ec7164c1}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a010b7fc8801c5b88aefa4137cf85186d}\label{classKite_1_1TrackFixedSegment_a010b7fc8801c5b88aefa4137cf85186d}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Next@{get\+Next}}
|
|
\index{get\+Next@{get\+Next}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Next()}{getNext()}}
|
|
{\footnotesize\ttfamily \hyperlink{classKite_1_1TrackElement}{Track\+Element} $\ast$ get\+Next (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The next \hyperlink{classKite_1_1TrackElement}{Track\+Element}, on the same track and of a {\itshape different} net. {\bfseries See also\+:}~ \hyperlink{classKite_1_1Track_af3db59591bef3c690ace92c114a4e4aa}{Track\+::get\+Next()}.
|
|
|
|
Reimplemented from \hyperlink{classKite_1_1TrackElement_a010b7fc8801c5b88aefa4137cf85186d}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a55d6115d84c11ad147f4c38fe372ea24}\label{classKite_1_1TrackFixedSegment_a55d6115d84c11ad147f4c38fe372ea24}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Previous@{get\+Previous}}
|
|
\index{get\+Previous@{get\+Previous}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Previous()}{getPrevious()}}
|
|
{\footnotesize\ttfamily \hyperlink{classKite_1_1TrackElement}{Track\+Element} $\ast$ get\+Previous (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The previous \hyperlink{classKite_1_1TrackElement}{Track\+Element}, on the same track and of a {\itshape different} net. {\bfseries See also\+:}~ \hyperlink{classKite_1_1Track_a290fcfe6131730d216951a3b5207d777}{Track\+::get\+Previous()}.
|
|
|
|
Reimplemented from \hyperlink{classKite_1_1TrackElement_a55d6115d84c11ad147f4c38fe372ea24}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_ab5b5aaa5b318369feee6003dbad039c2}\label{classKite_1_1TrackFixedSegment_ab5b5aaa5b318369feee6003dbad039c2}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Axis@{get\+Axis}}
|
|
\index{get\+Axis@{get\+Axis}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Axis()}{getAxis()}}
|
|
{\footnotesize\ttfamily \textbf{ Db\+U\+::\+Unit} get\+Axis (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The axis position of the element (must be the same as the \hyperlink{classKite_1_1Track}{Track}).
|
|
|
|
Implements \hyperlink{classKite_1_1TrackElement_ac492fb5399691d81c31547db6b56fd03}{Track\+Element}.
|
|
|
|
\mbox{\Hypertarget{classKite_1_1TrackFixedSegment_a034711e2d3617ea848ef9f5a18255e10}\label{classKite_1_1TrackFixedSegment_a034711e2d3617ea848ef9f5a18255e10}}
|
|
\index{Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}!get\+Free\+Interval@{get\+Free\+Interval}}
|
|
\index{get\+Free\+Interval@{get\+Free\+Interval}!Kite\+::\+Track\+Fixed\+Segment@{Kite\+::\+Track\+Fixed\+Segment}}
|
|
\paragraph{\texorpdfstring{get\+Free\+Interval()}{getFreeInterval()}}
|
|
{\footnotesize\ttfamily \textbf{ Interval} get\+Free\+Interval (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
{\bfseries Returns\+:} The greatest free interval enclosing this element.
|
|
|
|
Reimplemented from \hyperlink{classKite_1_1TrackElement_a034711e2d3617ea848ef9f5a18255e10}{Track\+Element}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
Track\+Fixed\+Segment.\+h\item
|
|
Track\+Fixed\+Segment.\+cpp\item
|
|
Track\+Fixed\+Segment.\+dox\end{DoxyCompactItemize}
|