\hypertarget{classHurricane_1_1Horizontal}{}\section{Hurricane\+:\+:Horizontal Class Reference}
\label{classHurricane_1_1Horizontal}\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}


\mbox{\hyperlink{classHurricane_1_1Horizontal}{Horizontal}} description ({\bfseries A\+PI})  




Inheritance diagram for Hurricane\+:\+:Horizontal\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=194pt]{classHurricane_1_1Horizontal__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \mbox{\hyperlink{classHurricane_1_1Segment}{Segment}} \mbox{\hyperlink{classHurricane_1_1Horizontal_a43266e3530dc5872f4eabf16eba86bdb}{Inherit}}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \& \mbox{\hyperlink{classHurricane_1_1Horizontal_a7fdafaa2a7e931413efb2c1fc021f4a8}{get\+Dx\+Source}} () const
\item 
const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \& \mbox{\hyperlink{classHurricane_1_1Horizontal_aab807785755e4229f215aee3f3b16941}{get\+Dx\+Target}} () const
\item 
void \mbox{\hyperlink{classHurricane_1_1Horizontal_a794aa68157beb2d04816a5f4e9160187}{setY}} (const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&y)
\item 
void \mbox{\hyperlink{classHurricane_1_1Horizontal_a3d01a89cb24cdb29dda86ac9910c7530}{translate}} (const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&dy)
\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{classHurricane_1_1Horizontal}{Horizontal}} $\ast$ \mbox{\hyperlink{classHurricane_1_1Horizontal_a15f13508993b6c0219fb944fe1141c3f}{create}} (\mbox{\hyperlink{classHurricane_1_1Net}{Net}} $\ast$net, const \mbox{\hyperlink{classHurricane_1_1Layer}{Layer}} $\ast$layer, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&y, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&width=0, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&dx\+Source=0, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&dx\+Target=0)
\item 
static \mbox{\hyperlink{classHurricane_1_1Horizontal}{Horizontal}} $\ast$ \mbox{\hyperlink{classHurricane_1_1Horizontal_ac30e0cbdfdd1f2cb02f000380652daf7}{create}} (\mbox{\hyperlink{classHurricane_1_1Component}{Component}} $\ast$source, \mbox{\hyperlink{classHurricane_1_1Component}{Component}} $\ast$target, const \mbox{\hyperlink{classHurricane_1_1Layer}{Layer}} $\ast$layer, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&y, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&width=0, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&dx\+Source=0, const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&dx\+Target=0)
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\mbox{\hyperlink{classHurricane_1_1Horizontal}{Horizontal}} description ({\bfseries A\+PI}) 

\hypertarget{classHurricane_1_1Horizontal_secHorizontalIntro}{}\subsection{Introduction}\label{classHurricane_1_1Horizontal_secHorizontalIntro}
A horizontal has, in addition to inherited attributes, a specific one \+: its ordinate. The horizontal extend of the segment is defined by the \char`\"{}source\char`\"{} and \char`\"{}target\char`\"{} components on which it is anchored.

This ordinate allows, among other things, to anchor a horizontal segment extremity on a component (i.\+e. a contact) with a small vertical offset without the need to materialize it, because it is implicitely equal to the difference between the horizontal ordinate and the component ordinate. It allows also, and it not the least interesting feature, to anchor an extremity of a horizontal directly on a vertical segment (and conversely) without the need to create an intermediate contact (unless they are on different layers!). The ordinate of the implicit contact point is the one of the horizontal and the abscissa the one of the vertical). 

\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{classHurricane_1_1Horizontal_a43266e3530dc5872f4eabf16eba86bdb}\label{classHurricane_1_1Horizontal_a43266e3530dc5872f4eabf16eba86bdb}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!Inherit@{Inherit}}
\index{Inherit@{Inherit}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{Inherit}{Inherit}}
{\footnotesize\ttfamily \mbox{\hyperlink{classHurricane_1_1Horizontal_a43266e3530dc5872f4eabf16eba86bdb}{Hurricane\+::\+Horizontal\+::\+Inherit}}}

Useful for calling upon methods of the base class without knowing it. 

\subsection{Member Function Documentation}
\mbox{\Hypertarget{classHurricane_1_1Horizontal_a15f13508993b6c0219fb944fe1141c3f}\label{classHurricane_1_1Horizontal_a15f13508993b6c0219fb944fe1141c3f}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!create@{create}}
\index{create@{create}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \mbox{\hyperlink{classHurricane_1_1Horizontal}{Horizontal}} $\ast$ Hurricane\+::\+Horizontal\+::create (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classHurricane_1_1Net}{Net}} $\ast$}]{net,  }\item[{const \mbox{\hyperlink{classHurricane_1_1Layer}{Layer}} $\ast$}]{layer,  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{y,  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{width = {\ttfamily 0},  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{dx\+Source = {\ttfamily 0},  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{dx\+Target = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}

creates and returns an absolute horizontal segment with layer {\ttfamily $<$layer$>$}, located at ordinate {\ttfamily $<$y$>$} and of width {\ttfamily $<$width$>$}. The differents extremities abscissas are given by {\ttfamily $<$dx\+Source$>$} and {\ttfamily $<$dx\+Target$>$}.

\begin{DoxyParagraph}{Caution\+: Throws an exception if any of the net or layer pointers is }
null. 
\end{DoxyParagraph}
\mbox{\Hypertarget{classHurricane_1_1Horizontal_ac30e0cbdfdd1f2cb02f000380652daf7}\label{classHurricane_1_1Horizontal_ac30e0cbdfdd1f2cb02f000380652daf7}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!create@{create}}
\index{create@{create}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{create()}{create()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \mbox{\hyperlink{classHurricane_1_1Horizontal}{Horizontal}} $\ast$ Hurricane\+::\+Horizontal\+::create (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classHurricane_1_1Component}{Component}} $\ast$}]{source,  }\item[{\mbox{\hyperlink{classHurricane_1_1Component}{Component}} $\ast$}]{target,  }\item[{const \mbox{\hyperlink{classHurricane_1_1Layer}{Layer}} $\ast$}]{layer,  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{y,  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{width = {\ttfamily 0},  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{dx\+Source = {\ttfamily 0},  }\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{dx\+Target = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}

No description. \mbox{\Hypertarget{classHurricane_1_1Horizontal_a7fdafaa2a7e931413efb2c1fc021f4a8}\label{classHurricane_1_1Horizontal_a7fdafaa2a7e931413efb2c1fc021f4a8}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!get\+Dx\+Source@{get\+Dx\+Source}}
\index{get\+Dx\+Source@{get\+Dx\+Source}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{get\+Dx\+Source()}{getDxSource()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \& Hurricane\+::\+Horizontal\+::get\+Dx\+Source (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

{\bfseries Returns\+:} the relative source abscissa of the segment (may be absolute if the source extremity isn\textquotesingle{}t anchored).

\begin{DoxyParagraph}{Remark\+: If you want to get the absolute one use the member function }
get\+Source\+Y() defined at the \mbox{\hyperlink{classHurricane_1_1Segment}{Segment}} level. 
\end{DoxyParagraph}
\mbox{\Hypertarget{classHurricane_1_1Horizontal_aab807785755e4229f215aee3f3b16941}\label{classHurricane_1_1Horizontal_aab807785755e4229f215aee3f3b16941}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!get\+Dx\+Target@{get\+Dx\+Target}}
\index{get\+Dx\+Target@{get\+Dx\+Target}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{get\+Dx\+Target()}{getDxTarget()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \& Hurricane\+::\+Horizontal\+::get\+Dx\+Target (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

{\bfseries Returns\+:} the relative target abscissa of the segment (may be absolute if the target extremity isn\textquotesingle{}t anchored).

\begin{DoxyParagraph}{Remark\+: If you want to get the absolute one use the member function }
get\+Target\+Y() defined at the \mbox{\hyperlink{classHurricane_1_1Segment}{Segment}} level. 
\end{DoxyParagraph}
\mbox{\Hypertarget{classHurricane_1_1Horizontal_a794aa68157beb2d04816a5f4e9160187}\label{classHurricane_1_1Horizontal_a794aa68157beb2d04816a5f4e9160187}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!setY@{setY}}
\index{setY@{setY}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{set\+Y()}{setY()}}
{\footnotesize\ttfamily void Hurricane\+::\+Horizontal\+::setY (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{x }\end{DoxyParamCaption})}

sets the ordinate of the segment. \mbox{\Hypertarget{classHurricane_1_1Horizontal_a3d01a89cb24cdb29dda86ac9910c7530}\label{classHurricane_1_1Horizontal_a3d01a89cb24cdb29dda86ac9910c7530}} 
\index{Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}!translate@{translate}}
\index{translate@{translate}!Hurricane\+::\+Horizontal@{Hurricane\+::\+Horizontal}}
\subsubsection{\texorpdfstring{translate()}{translate()}}
{\footnotesize\ttfamily void Hurricane\+::\+Horizontal\+::translate (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__DbUGroup_ga4fbfa3e8c89347af76c9628ea06c4146}{Db\+U\+::\+Unit}} \&}]{dy }\end{DoxyParamCaption})}

translate verticaly the horizontal segment of the quantity {\ttfamily $<$dy$>$}. 

The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Horizontal.\+h\item 
Horizontal.\+dox\end{DoxyCompactItemize}
