140 lines
7.1 KiB
TeX
140 lines
7.1 KiB
TeX
\hypertarget{class_chrom}{}\doxysection{Chrom Class Reference}
|
|
\label{class_chrom}\index{Chrom@{Chrom}}
|
|
|
|
|
|
Inheritance diagram for Chrom\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=285pt]{class_chrom__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for Chrom\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=285pt]{class_chrom__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::string \mbox{\hyperlink{class_chrom_add11d2521aff5c8302ade751dd1bd6fc}{class\+Name}} () const
|
|
\item
|
|
void \mbox{\hyperlink{class_chrom_a5bcdd543e127cf6086efba9b9fd7a9cf}{print\+On}} (std\+::ostream \&os) const
|
|
\item
|
|
void \mbox{\hyperlink{class_chrom_a4f37f3f706bf8cac0a25a8446b56a95a}{read\+From}} (std\+::istream \&is)
|
|
\item
|
|
std\+::string \mbox{\hyperlink{class_chrom_add11d2521aff5c8302ade751dd1bd6fc}{class\+Name}} () const
|
|
\item
|
|
void \mbox{\hyperlink{class_chrom_a5bcdd543e127cf6086efba9b9fd7a9cf}{print\+On}} (std\+::ostream \&os) const
|
|
\item
|
|
void \mbox{\hyperlink{class_chrom_a4f37f3f706bf8cac0a25a8446b56a95a}{read\+From}} (std\+::istream \&is)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Additional Inherited Members}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{class_chrom_add11d2521aff5c8302ade751dd1bd6fc}\label{class_chrom_add11d2521aff5c8302ade751dd1bd6fc}}
|
|
\index{Chrom@{Chrom}!className@{className}}
|
|
\index{className@{className}!Chrom@{Chrom}}
|
|
\doxysubsubsection{\texorpdfstring{className()}{className()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily std\+::string Chrom\+::class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Return the class id. This should be redefined in each class. Only \char`\"{}leaf\char`\"{} classes can be non-\/virtual.
|
|
|
|
Maarten\+: removed the default implementation as this proved to be too error-\/prone\+: I found several classes that had a typo in class\+Name (like classname), which would print \mbox{\hyperlink{classeo_object}{eo\+Object}} instead of their own. Having it pure will force the implementor to provide a name.
|
|
|
|
Implements \mbox{\hyperlink{classeo_object_a1c02745db786e7bb46dea93b560fe685}{eo\+Object}}.
|
|
|
|
\mbox{\Hypertarget{class_chrom_add11d2521aff5c8302ade751dd1bd6fc}\label{class_chrom_add11d2521aff5c8302ade751dd1bd6fc}}
|
|
\index{Chrom@{Chrom}!className@{className}}
|
|
\index{className@{className}!Chrom@{Chrom}}
|
|
\doxysubsubsection{\texorpdfstring{className()}{className()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily std\+::string Chrom\+::class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Return the class id. This should be redefined in each class. Only \char`\"{}leaf\char`\"{} classes can be non-\/virtual.
|
|
|
|
Maarten\+: removed the default implementation as this proved to be too error-\/prone\+: I found several classes that had a typo in class\+Name (like classname), which would print \mbox{\hyperlink{classeo_object}{eo\+Object}} instead of their own. Having it pure will force the implementor to provide a name.
|
|
|
|
Implements \mbox{\hyperlink{classeo_object_a1c02745db786e7bb46dea93b560fe685}{eo\+Object}}.
|
|
|
|
\mbox{\Hypertarget{class_chrom_a5bcdd543e127cf6086efba9b9fd7a9cf}\label{class_chrom_a5bcdd543e127cf6086efba9b9fd7a9cf}}
|
|
\index{Chrom@{Chrom}!printOn@{printOn}}
|
|
\index{printOn@{printOn}!Chrom@{Chrom}}
|
|
\doxysubsubsection{\texorpdfstring{printOn()}{printOn()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily void Chrom\+::print\+On (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{\+\_\+os }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Write object. Called print\+On since it prints the object {\itshape on} a stream.
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+os} & A std\+::ostream. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{class_e_o_a3a022b10acf3d67e61c253caf1d76356}{E\+O$<$ phenotype $>$}}.
|
|
|
|
\mbox{\Hypertarget{class_chrom_a5bcdd543e127cf6086efba9b9fd7a9cf}\label{class_chrom_a5bcdd543e127cf6086efba9b9fd7a9cf}}
|
|
\index{Chrom@{Chrom}!printOn@{printOn}}
|
|
\index{printOn@{printOn}!Chrom@{Chrom}}
|
|
\doxysubsubsection{\texorpdfstring{printOn()}{printOn()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily void Chrom\+::print\+On (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{\+\_\+os }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Write object. Called print\+On since it prints the object {\itshape on} a stream.
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+os} & A std\+::ostream. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{class_e_o_a3a022b10acf3d67e61c253caf1d76356}{E\+O$<$ phenotype $>$}}.
|
|
|
|
\mbox{\Hypertarget{class_chrom_a4f37f3f706bf8cac0a25a8446b56a95a}\label{class_chrom_a4f37f3f706bf8cac0a25a8446b56a95a}}
|
|
\index{Chrom@{Chrom}!readFrom@{readFrom}}
|
|
\index{readFrom@{readFrom}!Chrom@{Chrom}}
|
|
\doxysubsubsection{\texorpdfstring{readFrom()}{readFrom()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily void Chrom\+::read\+From (\begin{DoxyParamCaption}\item[{std\+::istream \&}]{\+\_\+is }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Read object.\textbackslash{} Calls base class, just in case that one had something to do. The read and print methods should be compatible and have the same format. In principle, format is \char`\"{}plain\char`\"{}\+: they just print a number
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+is} & a std\+::istream. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em runtime\+\_\+std\+::exception} & If a valid object can\textquotesingle{}t be read. \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{class_e_o_a8d98b330d6a8c2b4e3371eae2b2d7e48}{E\+O$<$ phenotype $>$}}.
|
|
|
|
\mbox{\Hypertarget{class_chrom_a4f37f3f706bf8cac0a25a8446b56a95a}\label{class_chrom_a4f37f3f706bf8cac0a25a8446b56a95a}}
|
|
\index{Chrom@{Chrom}!readFrom@{readFrom}}
|
|
\index{readFrom@{readFrom}!Chrom@{Chrom}}
|
|
\doxysubsubsection{\texorpdfstring{readFrom()}{readFrom()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily void Chrom\+::read\+From (\begin{DoxyParamCaption}\item[{std\+::istream \&}]{\+\_\+is }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Read object.\textbackslash{} Calls base class, just in case that one had something to do. The read and print methods should be compatible and have the same format. In principle, format is \char`\"{}plain\char`\"{}\+: they just print a number
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+is} & a std\+::istream. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em runtime\+\_\+std\+::exception} & If a valid object can\textquotesingle{}t be read. \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{class_e_o_a8d98b330d6a8c2b4e3371eae2b2d7e48}{E\+O$<$ phenotype $>$}}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
deprecated/eo/app/gprop/gprop.\+h\end{DoxyCompactItemize}
|