\hypertarget{classChart}{\section{Chart Class Reference} \label{classChart}\index{Chart@{Chart}} } Inheritance diagram for Chart\-: \nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[height=550pt]{classChart__inherit__graph} \end{center} \end{figure} Collaboration diagram for Chart\-: \nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=350pt]{classChart__coll__graph} \end{center} \end{figure} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item boolean \hyperlink{classChart_aa00344c63468809411f6b9993f16b988}{Set\-Chart\-Title} (String title) \begin{DoxyCompactList}\small\item\em Set the Title of the chart. \end{DoxyCompactList}\item String \hyperlink{classChart_a9359bec3f3e598e7e77d9619f917c351}{Get\-Chart\-Title} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Chart\-Title. \end{DoxyCompactList}\item boolean \hyperlink{classChart_aaa5d121cc392b59ddfaa7a0b9cc5bbc5}{Set\-Author} (String author) \begin{DoxyCompactList}\small\item\em Set the Author of the chart. \end{DoxyCompactList}\item String \hyperlink{classChart_a7ba11f3491e0ca9dc620275229f19621}{Get\-Author} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Author. \end{DoxyCompactList}\item boolean \hyperlink{classChart_adf9b3f84dfd38a8c1605d87ed51d6a8d}{Set\-Date} (Boolean date) \begin{DoxyCompactList}\small\item\em Mutator for m\-\_\-\-Date -\/ the Date of the chart. \end{DoxyCompactList}\item Boolean \hyperlink{classChart_ad9f8007012bfa1220466f5296a0a44ad}{Get\-Date} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Date. \end{DoxyCompactList}\item boolean \hyperlink{classChart_aefbb479cfe647bc1a67ce5093c42db91}{Set\-Description} (String descr) \begin{DoxyCompactList}\small\item\em Mutator for m\-\_\-\-Description -\/ Description of the chart. \end{DoxyCompactList}\item String \hyperlink{classChart_a9d84b1757535de24549492104e011d24}{Get\-Description} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Description. \end{DoxyCompactList}\item boolean \hyperlink{classChart_ac38d542d08025feb99bf8c429aada0e8}{Set\-X\-Axis} (String x\-Axis) \begin{DoxyCompactList}\small\item\em Mutator method for m\-\_\-\-X\-Axis -\/ X Axis Label of chart. \end{DoxyCompactList}\item String \hyperlink{classChart_a37d617c7975e5bad48c99c1f5b787e5b}{Get\-X\-Axis} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-X\-Axis. \end{DoxyCompactList}\item boolean \hyperlink{classChart_a2cf2b4e4a5e4e80a2141ec2839539d28}{Set\-Y\-Axis} (String y\-Axis) \begin{DoxyCompactList}\small\item\em Mutator method of m\-\_\-\-Y\-Axis -\/ Y Axis Label of chart. \end{DoxyCompactList}\item String \hyperlink{classChart_aa0ed2c5f1c8d40652e3235bde6004bf5}{Get\-Y\-Axis} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Y\-Axis. \end{DoxyCompactList}\item J\-Free\-Chart \hyperlink{classChart_a085bfb2e89ff7a2d921729eb3cf2668c}{Get\-Chart} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Chart -\/ internal chart structure. \end{DoxyCompactList}\item boolean \hyperlink{classChart_a6944358fffc8a05fe878450014f1e8ef}{Set\-Chart} (J\-Free\-Chart chart) \begin{DoxyCompactList}\small\item\em Mutator for m\-\_\-\-Chart -\/ internal data storage. \end{DoxyCompactList}\item boolean \hyperlink{classChart_a7c033356c226ed6428cb6ed9ccf6acab}{Set\-Colour} (\hyperlink{classColourList}{Colour\-List} colour) \begin{DoxyCompactList}\small\item\em Mutator method for m\-\_\-\-Colour -\/ colour scheme of chart. \end{DoxyCompactList}\item boolean \hyperlink{classChart_a7b28c8a6b856cf125ce2d8daed800f86}{Set\-Legend} (Legend\-Title legend) \begin{DoxyCompactList}\small\item\em Mutator method of m\-\_\-\-Legend -\/ legent of chart. \end{DoxyCompactList}\item Legend\-Title \hyperlink{classChart_a7e00d061b95961ae44890bb5b0efe464}{Get\-Legend} () \begin{DoxyCompactList}\small\item\em Accessor for m\-\_\-\-Legend. \end{DoxyCompactList}\item \hyperlink{classChart_a03fc8577600e0a4c7f1cb9556e97acd0}{Chart} (\hyperlink{classChartData}{Chart\-Data} data, String title, String colour\-Scheme, Array\-List$<$ Color $>$ user\-List) \begin{DoxyCompactList}\small\item\em Constructor from data, title and colour\-Scheme. \end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Protected Attributes} \begin{DoxyCompactItemize} \item \hypertarget{classChart_a649388d891c11cfbea672957b121d789}{J\-Free\-Chart {\bfseries m\-\_\-\-Chart}}\label{classChart_a649388d891c11cfbea672957b121d789} \item \hypertarget{classChart_a1f535a7adcc0539f11544a8490a9200e}{String {\bfseries m\-\_\-\-Chart\-Title}}\label{classChart_a1f535a7adcc0539f11544a8490a9200e} \item \hypertarget{classChart_a2a15bdf21cd31f70ebe4e88df01c9db1}{String {\bfseries m\-\_\-\-Author} = \char`\"{}\char`\"{}}\label{classChart_a2a15bdf21cd31f70ebe4e88df01c9db1} \item \hypertarget{classChart_a8749c01f3a302d14ab2c3d49ca77f6f8}{Boolean {\bfseries m\-\_\-\-Date} = false}\label{classChart_a8749c01f3a302d14ab2c3d49ca77f6f8} \item \hypertarget{classChart_afeac1683aa2cb5221498fd91977a6bf8}{String {\bfseries m\-\_\-\-Description} = \char`\"{}\char`\"{}}\label{classChart_afeac1683aa2cb5221498fd91977a6bf8} \item \hypertarget{classChart_ae1a50bd325d4f0181d774f1a10168b60}{String {\bfseries m\-\_\-\-X\-Axis} = \char`\"{}\char`\"{}}\label{classChart_ae1a50bd325d4f0181d774f1a10168b60} \item \hypertarget{classChart_a52a44e58f6c4982fee3a98fa25c05079}{String {\bfseries m\-\_\-\-Y\-Axis} = \char`\"{}\char`\"{}}\label{classChart_a52a44e58f6c4982fee3a98fa25c05079} \item \hypertarget{classChart_ae4e8bc984e062d9ce1c57f51c484789d}{Legend\-Title {\bfseries m\-\_\-\-Legend}}\label{classChart_ae4e8bc984e062d9ce1c57f51c484789d} \end{DoxyCompactItemize} \subsection*{Additional Inherited Members} \subsection{Constructor \& Destructor Documentation} \hypertarget{classChart_a03fc8577600e0a4c7f1cb9556e97acd0}{\index{Chart@{Chart}!Chart@{Chart}} \index{Chart@{Chart}!Chart@{Chart}} \subsubsection[{Chart}]{\setlength{\rightskip}{0pt plus 5cm}Chart.\-Chart ( \begin{DoxyParamCaption} \item[{{\bf Chart\-Data}}]{data, } \item[{String}]{title, } \item[{String}]{colour\-Scheme, } \item[{Array\-List$<$ Color $>$}]{user\-List} \end{DoxyParamCaption} )}}\label{classChart_a03fc8577600e0a4c7f1cb9556e97acd0} Constructor from data, title and colour\-Scheme. \begin{DoxyParams}{Parameters} {\em data} & -\/ chart specific data \\ \hline {\em title} & -\/ title of the chart \\ \hline {\em colour\-Scheme} & -\/ the colour scheme to draw the graph with \\ \hline {\em user\-List} & -\/ the user defined list to create the colours with\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} Here is the call graph for this function\-: \nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=296pt]{classChart_a03fc8577600e0a4c7f1cb9556e97acd0_cgraph} \end{center} \end{figure} \subsection{Member Function Documentation} \hypertarget{classChart_a7ba11f3491e0ca9dc620275229f19621}{\index{Chart@{Chart}!Get\-Author@{Get\-Author}} \index{Get\-Author@{Get\-Author}!Chart@{Chart}} \subsubsection[{Get\-Author}]{\setlength{\rightskip}{0pt plus 5cm}String Chart.\-Get\-Author ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_a7ba11f3491e0ca9dc620275229f19621} Accessor for m\-\_\-\-Author. \begin{DoxyReturn}{Returns} -\/ Author String \end{DoxyReturn} \hypertarget{classChart_a085bfb2e89ff7a2d921729eb3cf2668c}{\index{Chart@{Chart}!Get\-Chart@{Get\-Chart}} \index{Get\-Chart@{Get\-Chart}!Chart@{Chart}} \subsubsection[{Get\-Chart}]{\setlength{\rightskip}{0pt plus 5cm}J\-Free\-Chart Chart.\-Get\-Chart ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_a085bfb2e89ff7a2d921729eb3cf2668c} Accessor for m\-\_\-\-Chart -\/ internal chart structure. \begin{DoxyReturn}{Returns} -\/ memmory address of internal chart structure \end{DoxyReturn} \hypertarget{classChart_a9359bec3f3e598e7e77d9619f917c351}{\index{Chart@{Chart}!Get\-Chart\-Title@{Get\-Chart\-Title}} \index{Get\-Chart\-Title@{Get\-Chart\-Title}!Chart@{Chart}} \subsubsection[{Get\-Chart\-Title}]{\setlength{\rightskip}{0pt plus 5cm}String Chart.\-Get\-Chart\-Title ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_a9359bec3f3e598e7e77d9619f917c351} Accessor for m\-\_\-\-Chart\-Title. \begin{DoxyReturn}{Returns} -\/ \hyperlink{classChart}{Chart} Title String \end{DoxyReturn} \hypertarget{classChart_ad9f8007012bfa1220466f5296a0a44ad}{\index{Chart@{Chart}!Get\-Date@{Get\-Date}} \index{Get\-Date@{Get\-Date}!Chart@{Chart}} \subsubsection[{Get\-Date}]{\setlength{\rightskip}{0pt plus 5cm}Boolean Chart.\-Get\-Date ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_ad9f8007012bfa1220466f5296a0a44ad} Accessor for m\-\_\-\-Date. \begin{DoxyReturn}{Returns} -\/ Date Boolean \end{DoxyReturn} \hypertarget{classChart_a9d84b1757535de24549492104e011d24}{\index{Chart@{Chart}!Get\-Description@{Get\-Description}} \index{Get\-Description@{Get\-Description}!Chart@{Chart}} \subsubsection[{Get\-Description}]{\setlength{\rightskip}{0pt plus 5cm}String Chart.\-Get\-Description ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_a9d84b1757535de24549492104e011d24} Accessor for m\-\_\-\-Description. \begin{DoxyReturn}{Returns} -\/ Description String \end{DoxyReturn} \hypertarget{classChart_a7e00d061b95961ae44890bb5b0efe464}{\index{Chart@{Chart}!Get\-Legend@{Get\-Legend}} \index{Get\-Legend@{Get\-Legend}!Chart@{Chart}} \subsubsection[{Get\-Legend}]{\setlength{\rightskip}{0pt plus 5cm}Legend\-Title Chart.\-Get\-Legend ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_a7e00d061b95961ae44890bb5b0efe464} Accessor for m\-\_\-\-Legend. \begin{DoxyReturn}{Returns} -\/ Legend\-Title Legend \end{DoxyReturn} \hypertarget{classChart_a37d617c7975e5bad48c99c1f5b787e5b}{\index{Chart@{Chart}!Get\-X\-Axis@{Get\-X\-Axis}} \index{Get\-X\-Axis@{Get\-X\-Axis}!Chart@{Chart}} \subsubsection[{Get\-X\-Axis}]{\setlength{\rightskip}{0pt plus 5cm}String Chart.\-Get\-X\-Axis ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_a37d617c7975e5bad48c99c1f5b787e5b} Accessor for m\-\_\-\-X\-Axis. \begin{DoxyReturn}{Returns} -\/ X Axis String \end{DoxyReturn} \hypertarget{classChart_aa0ed2c5f1c8d40652e3235bde6004bf5}{\index{Chart@{Chart}!Get\-Y\-Axis@{Get\-Y\-Axis}} \index{Get\-Y\-Axis@{Get\-Y\-Axis}!Chart@{Chart}} \subsubsection[{Get\-Y\-Axis}]{\setlength{\rightskip}{0pt plus 5cm}String Chart.\-Get\-Y\-Axis ( \begin{DoxyParamCaption} {} \end{DoxyParamCaption} )}}\label{classChart_aa0ed2c5f1c8d40652e3235bde6004bf5} Accessor for m\-\_\-\-Y\-Axis. \begin{DoxyReturn}{Returns} -\/ Y Axis String \end{DoxyReturn} \hypertarget{classChart_aaa5d121cc392b59ddfaa7a0b9cc5bbc5}{\index{Chart@{Chart}!Set\-Author@{Set\-Author}} \index{Set\-Author@{Set\-Author}!Chart@{Chart}} \subsubsection[{Set\-Author}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Author ( \begin{DoxyParamCaption} \item[{String}]{author} \end{DoxyParamCaption} )}}\label{classChart_aaa5d121cc392b59ddfaa7a0b9cc5bbc5} Set the Author of the chart. \begin{DoxyParams}{Parameters} {\em author} & is the String that the user has specified to be used\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_a6944358fffc8a05fe878450014f1e8ef}{\index{Chart@{Chart}!Set\-Chart@{Set\-Chart}} \index{Set\-Chart@{Set\-Chart}!Chart@{Chart}} \subsubsection[{Set\-Chart}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Chart ( \begin{DoxyParamCaption} \item[{J\-Free\-Chart}]{chart} \end{DoxyParamCaption} )}}\label{classChart_a6944358fffc8a05fe878450014f1e8ef} Mutator for m\-\_\-\-Chart -\/ internal data storage. \begin{DoxyParams}{Parameters} {\em chart} & -\/ chart data to be loaded into class\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_aa00344c63468809411f6b9993f16b988}{\index{Chart@{Chart}!Set\-Chart\-Title@{Set\-Chart\-Title}} \index{Set\-Chart\-Title@{Set\-Chart\-Title}!Chart@{Chart}} \subsubsection[{Set\-Chart\-Title}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Chart\-Title ( \begin{DoxyParamCaption} \item[{String}]{title} \end{DoxyParamCaption} )}}\label{classChart_aa00344c63468809411f6b9993f16b988} Set the Title of the chart. \begin{DoxyParams}{Parameters} {\em title} & -\/ New title to be added\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_a7c033356c226ed6428cb6ed9ccf6acab}{\index{Chart@{Chart}!Set\-Colour@{Set\-Colour}} \index{Set\-Colour@{Set\-Colour}!Chart@{Chart}} \subsubsection[{Set\-Colour}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Colour ( \begin{DoxyParamCaption} \item[{{\bf Colour\-List}}]{colour} \end{DoxyParamCaption} )}}\label{classChart_a7c033356c226ed6428cb6ed9ccf6acab} Mutator method for m\-\_\-\-Colour -\/ colour scheme of chart. \begin{DoxyParams}{Parameters} {\em colour} & -\/ \hyperlink{classColourList}{Colour\-List} of colours to be applied\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} Here is the call graph for this function\-: \nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=324pt]{classChart_a7c033356c226ed6428cb6ed9ccf6acab_cgraph} \end{center} \end{figure} \hypertarget{classChart_adf9b3f84dfd38a8c1605d87ed51d6a8d}{\index{Chart@{Chart}!Set\-Date@{Set\-Date}} \index{Set\-Date@{Set\-Date}!Chart@{Chart}} \subsubsection[{Set\-Date}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Date ( \begin{DoxyParamCaption} \item[{Boolean}]{date} \end{DoxyParamCaption} )}}\label{classChart_adf9b3f84dfd38a8c1605d87ed51d6a8d} Mutator for m\-\_\-\-Date -\/ the Date of the chart. \begin{DoxyParams}{Parameters} {\em date} & is the boolean indicating whether to include a Date\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_aefbb479cfe647bc1a67ce5093c42db91}{\index{Chart@{Chart}!Set\-Description@{Set\-Description}} \index{Set\-Description@{Set\-Description}!Chart@{Chart}} \subsubsection[{Set\-Description}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Description ( \begin{DoxyParamCaption} \item[{String}]{descr} \end{DoxyParamCaption} )}}\label{classChart_aefbb479cfe647bc1a67ce5093c42db91} Mutator for m\-\_\-\-Description -\/ Description of the chart. \begin{DoxyParams}{Parameters} {\em descr} & is the String that the user has specified to be used\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_a7b28c8a6b856cf125ce2d8daed800f86}{\index{Chart@{Chart}!Set\-Legend@{Set\-Legend}} \index{Set\-Legend@{Set\-Legend}!Chart@{Chart}} \subsubsection[{Set\-Legend}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Legend ( \begin{DoxyParamCaption} \item[{Legend\-Title}]{legend} \end{DoxyParamCaption} )}}\label{classChart_a7b28c8a6b856cf125ce2d8daed800f86} Mutator method of m\-\_\-\-Legend -\/ legent of chart. \begin{DoxyParams}{Parameters} {\em -\/} & legend is the Legend\-Title that the user has specified to be used\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_ac38d542d08025feb99bf8c429aada0e8}{\index{Chart@{Chart}!Set\-X\-Axis@{Set\-X\-Axis}} \index{Set\-X\-Axis@{Set\-X\-Axis}!Chart@{Chart}} \subsubsection[{Set\-X\-Axis}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-X\-Axis ( \begin{DoxyParamCaption} \item[{String}]{x\-Axis} \end{DoxyParamCaption} )}}\label{classChart_ac38d542d08025feb99bf8c429aada0e8} Mutator method for m\-\_\-\-X\-Axis -\/ X Axis Label of chart. \begin{DoxyParams}{Parameters} {\em x\-Axis} & is the String that the user has specified to be used\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} \hypertarget{classChart_a2cf2b4e4a5e4e80a2141ec2839539d28}{\index{Chart@{Chart}!Set\-Y\-Axis@{Set\-Y\-Axis}} \index{Set\-Y\-Axis@{Set\-Y\-Axis}!Chart@{Chart}} \subsubsection[{Set\-Y\-Axis}]{\setlength{\rightskip}{0pt plus 5cm}boolean Chart.\-Set\-Y\-Axis ( \begin{DoxyParamCaption} \item[{String}]{y\-Axis} \end{DoxyParamCaption} )}}\label{classChart_a2cf2b4e4a5e4e80a2141ec2839539d28} Mutator method of m\-\_\-\-Y\-Axis -\/ Y Axis Label of chart. \begin{DoxyParams}{Parameters} {\em -\/} & y\-Axis is the String that the user has specified to be used\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} -\/ success \end{DoxyReturn} The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize} \item \hyperlink{Chart_8java}{Chart.\-java}\end{DoxyCompactItemize}