ponytracker/documentation/latex/motifs_8c.tex

223 lines
14 KiB
TeX

\hypertarget{motifs_8c}{\section{Référence du fichier sources/motifs/motifs.c}
\label{motifs_8c}\index{sources/motifs/motifs.\-c@{sources/motifs/motifs.\-c}}
}
{\ttfamily \#include $<$string.\-h$>$}\\*
{\ttfamily \#include \char`\"{}motifs.\-h\char`\"{}}\\*
\subsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
int \hyperlink{motifs_8c_a7d602ef1c04ef5126146f9b1b3c71c8f}{get\-Id\-Motif} (\hyperlink{struct__motif}{Motif} $\ast$m)
\item
void \hyperlink{motifs_8c_ad004e9f91ca7bcc9411c549a4fe62451}{ajouter\-Motif} (\hyperlink{struct__motif}{Motif} $\ast$$\ast$pliste, int nbr\-Tmp, int nbr\-Portees)
\item
void \hyperlink{motifs_8c_acc86e3bfa2b84ae375ca472e95967ac6}{definir\-Nom\-Motif} (\hyperlink{struct__motif}{Motif} $\ast$m, char $\ast$nom)
\item
void \hyperlink{motifs_8c_acd5428841ea3c29a618974d40bc9efe9}{supprimer\-Motif} (\hyperlink{struct__motif}{Motif} $\ast$$\ast$cellule, int nbr\-Portees)
\item
void \hyperlink{motifs_8c_af42173fbd180b1aa00e97a49d77f56f6}{definir\-Note} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp, int note)
\item
void \hyperlink{motifs_8c_a46fa52652960a1485a604a3e1017e3cc}{definir\-Octave} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp, int octave)
\item
void \hyperlink{motifs_8c_af1e94966c6af95f5a3091721dd62f7db}{definir\-Instrument} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp, int instrument)
\item
void \hyperlink{motifs_8c_a8aee8833f47e110e27de823ac557e8ac}{definir\-Volume} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp, int volume)
\item
void \hyperlink{motifs_8c_adc0b31b456f810c890b94357f3ba8a85}{definir\-Effet} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp, int effet)
\item
void \hyperlink{motifs_8c_aa74ce94a714f4487b60b3ddcac7bb645}{supprimer\-Note} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp)
\item
int \hyperlink{motifs_8c_ad9706b025d4ab4474778af8b6a3c1a66}{get\-Note} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp)
\item
int \hyperlink{motifs_8c_a5e7e5ab1812e838fddfa82c3682c4708}{get\-Octave} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp)
\item
int \hyperlink{motifs_8c_a6b6a18807e4f73c7710d611c7ff6d9f6}{get\-Instrument} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp)
\item
int \hyperlink{motifs_8c_a8c81aabb9b5fa55bad1c2ddb8d2ee6a9}{get\-Volume} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp)
\item
int \hyperlink{motifs_8c_a8c6e71f1d25b4a9fba76a3527a592a8b}{get\-Effet} (\hyperlink{struct__motif}{Motif} $\ast$m, int portee, int tmp)
\end{DoxyCompactItemize}
\subsection{Description détaillée}
Ce module implémente les fonctions du fichier \hyperlink{motifs_8h}{motifs.\-h}
\begin{DoxyVersion}{Version}
1
\end{DoxyVersion}
\begin{DoxyAuthor}{Auteur}
Module C\-S\-C3502 \-: Projet Informatique 1ère année T\-E\-L\-E\-C\-O\-M Sud\-Paris
\end{DoxyAuthor}
\begin{DoxyDate}{Date}
Mai 2014
\end{DoxyDate}
\subsection{Documentation des fonctions}
\hypertarget{motifs_8c_ad004e9f91ca7bcc9411c549a4fe62451}{\index{motifs.\-c@{motifs.\-c}!ajouter\-Motif@{ajouter\-Motif}}
\index{ajouter\-Motif@{ajouter\-Motif}!motifs.c@{motifs.\-c}}
\subsubsection[{ajouter\-Motif}]{\setlength{\rightskip}{0pt plus 5cm}void ajouter\-Motif (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$$\ast$}]{pliste, }
\item[{int}]{nbr\-Tmp, }
\item[{int}]{nbr\-Portees}
\end{DoxyParamCaption}
)}}\label{motifs_8c_ad004e9f91ca7bcc9411c549a4fe62451}
Permet d'ajouter un nouveau motif
\begin{DoxyParams}[1]{Paramètres}
\mbox{\tt out} & {\em pliste} & \-: liste de motifs \\
\hline
\mbox{\tt in} & {\em nbr\-Tmp} & \-: nombre de temps que doit contenir le motif \\
\hline
\mbox{\tt in} & {\em nbr\-Portees} & \-: nombre de portées que doit contenir le motif \\
\hline
\end{DoxyParams}
\hypertarget{motifs_8c_adc0b31b456f810c890b94357f3ba8a85}{\index{motifs.\-c@{motifs.\-c}!definir\-Effet@{definir\-Effet}}
\index{definir\-Effet@{definir\-Effet}!motifs.c@{motifs.\-c}}
\subsubsection[{definir\-Effet}]{\setlength{\rightskip}{0pt plus 5cm}void definir\-Effet (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp, }
\item[{int}]{effet}
\end{DoxyParamCaption}
)}}\label{motifs_8c_adc0b31b456f810c890b94357f3ba8a85}
Permet de définir l'effet donné à une note param\mbox{[}out\mbox{]} m \-: motif dans lequel on ajoute l'effet param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on ajoute l'effet param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on ajoute l'effet param\mbox{[}in\mbox{]} effet \-: effet donné à la note \hypertarget{motifs_8c_af1e94966c6af95f5a3091721dd62f7db}{\index{motifs.\-c@{motifs.\-c}!definir\-Instrument@{definir\-Instrument}}
\index{definir\-Instrument@{definir\-Instrument}!motifs.c@{motifs.\-c}}
\subsubsection[{definir\-Instrument}]{\setlength{\rightskip}{0pt plus 5cm}void definir\-Instrument (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp, }
\item[{int}]{intrument}
\end{DoxyParamCaption}
)}}\label{motifs_8c_af1e94966c6af95f5a3091721dd62f7db}
Permet de définir l'instrument jouant une note param\mbox{[}out\mbox{]} m \-: motif dans lequel on utilise cet instrument param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on utilise cet instrument param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on utilise cet instrument param\mbox{[}in\mbox{]} instrument \-: instrument que l'on utilise \hypertarget{motifs_8c_acc86e3bfa2b84ae375ca472e95967ac6}{\index{motifs.\-c@{motifs.\-c}!definir\-Nom\-Motif@{definir\-Nom\-Motif}}
\index{definir\-Nom\-Motif@{definir\-Nom\-Motif}!motifs.c@{motifs.\-c}}
\subsubsection[{definir\-Nom\-Motif}]{\setlength{\rightskip}{0pt plus 5cm}void definir\-Nom\-Motif (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{char $\ast$}]{nom}
\end{DoxyParamCaption}
)}}\label{motifs_8c_acc86e3bfa2b84ae375ca472e95967ac6}
Permet de nommer un motif
\begin{DoxyParams}[1]{Paramètres}
\mbox{\tt out} & {\em m} & \-: motif que l'on veut nommer \\
\hline
\mbox{\tt in} & {\em nom} & \-: nom que l'on donne au motif \\
\hline
\end{DoxyParams}
\hypertarget{motifs_8c_af42173fbd180b1aa00e97a49d77f56f6}{\index{motifs.\-c@{motifs.\-c}!definir\-Note@{definir\-Note}}
\index{definir\-Note@{definir\-Note}!motifs.c@{motifs.\-c}}
\subsubsection[{definir\-Note}]{\setlength{\rightskip}{0pt plus 5cm}void definir\-Note (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp, }
\item[{int}]{note}
\end{DoxyParamCaption}
)}}\label{motifs_8c_af42173fbd180b1aa00e97a49d77f56f6}
Permet de définir une note param\mbox{[}out\mbox{]} m \-: motif dans lequel on ajoute la note param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on ajoute la note param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on ajoute la note param\mbox{[}in\mbox{]} note \-: note que l'on ajoute \hypertarget{motifs_8c_a46fa52652960a1485a604a3e1017e3cc}{\index{motifs.\-c@{motifs.\-c}!definir\-Octave@{definir\-Octave}}
\index{definir\-Octave@{definir\-Octave}!motifs.c@{motifs.\-c}}
\subsubsection[{definir\-Octave}]{\setlength{\rightskip}{0pt plus 5cm}void definir\-Octave (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp, }
\item[{int}]{octave}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a46fa52652960a1485a604a3e1017e3cc}
Permet de définir une octave param\mbox{[}out\mbox{]} m \-: motif dans lequel on ajoute l'octave param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on ajoute l'octave param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on ajoute l'octave param\mbox{[}in\mbox{]} octave \-: octave que l'on ajoute à la note \hypertarget{motifs_8c_a8aee8833f47e110e27de823ac557e8ac}{\index{motifs.\-c@{motifs.\-c}!definir\-Volume@{definir\-Volume}}
\index{definir\-Volume@{definir\-Volume}!motifs.c@{motifs.\-c}}
\subsubsection[{definir\-Volume}]{\setlength{\rightskip}{0pt plus 5cm}void definir\-Volume (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp, }
\item[{int}]{volume}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a8aee8833f47e110e27de823ac557e8ac}
Permet de définir le volume d'une note param\mbox{[}out\mbox{]} m \-: motif dans lequel on modifie le volume param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on modifie le volume param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on modifie le volume param\mbox{[}in\mbox{]} volume \-: volume de la note \hypertarget{motifs_8c_a8c6e71f1d25b4a9fba76a3527a592a8b}{\index{motifs.\-c@{motifs.\-c}!get\-Effet@{get\-Effet}}
\index{get\-Effet@{get\-Effet}!motifs.c@{motifs.\-c}}
\subsubsection[{get\-Effet}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Effet (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a8c6e71f1d25b4a9fba76a3527a592a8b}
Permet d'afficher un effet donné param\mbox{[}out\mbox{]} m \-: motif dans lequel on affiche l'effet donné param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on affiche l'effet donné param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on affiche l'effet donné \hypertarget{motifs_8c_a7d602ef1c04ef5126146f9b1b3c71c8f}{\index{motifs.\-c@{motifs.\-c}!get\-Id\-Motif@{get\-Id\-Motif}}
\index{get\-Id\-Motif@{get\-Id\-Motif}!motifs.c@{motifs.\-c}}
\subsubsection[{get\-Id\-Motif}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Id\-Motif (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a7d602ef1c04ef5126146f9b1b3c71c8f}
Permet d'obtenir le numéro d'un motif
\begin{DoxyParams}[1]{Paramètres}
\mbox{\tt in} & {\em m} & \-: Mmtif dont on veut déterminer le numéro \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Le numéro du motif
\end{DoxyReturn}
\hypertarget{motifs_8c_a6b6a18807e4f73c7710d611c7ff6d9f6}{\index{motifs.\-c@{motifs.\-c}!get\-Instrument@{get\-Instrument}}
\index{get\-Instrument@{get\-Instrument}!motifs.c@{motifs.\-c}}
\subsubsection[{get\-Instrument}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Instrument (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a6b6a18807e4f73c7710d611c7ff6d9f6}
Permet d'afficher un instrument utilisé param\mbox{[}out\mbox{]} m \-: motif dans lequel on affiche l'instrument utilisé param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on affiche l'instrument utilisé param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on affiche l'instrument utilisé \hypertarget{motifs_8c_ad9706b025d4ab4474778af8b6a3c1a66}{\index{motifs.\-c@{motifs.\-c}!get\-Note@{get\-Note}}
\index{get\-Note@{get\-Note}!motifs.c@{motifs.\-c}}
\subsubsection[{get\-Note}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Note (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp}
\end{DoxyParamCaption}
)}}\label{motifs_8c_ad9706b025d4ab4474778af8b6a3c1a66}
Permet d'afficher une note param\mbox{[}out\mbox{]} m \-: motif dans lequel on affiche la note param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on affiche la note param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on affiche la note \hypertarget{motifs_8c_a5e7e5ab1812e838fddfa82c3682c4708}{\index{motifs.\-c@{motifs.\-c}!get\-Octave@{get\-Octave}}
\index{get\-Octave@{get\-Octave}!motifs.c@{motifs.\-c}}
\subsubsection[{get\-Octave}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Octave (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a5e7e5ab1812e838fddfa82c3682c4708}
Permet d'afficher une octave param\mbox{[}out\mbox{]} m \-: motif dans lequel on affiche l'octave param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on affiche l'octave param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on affiche l'octave \hypertarget{motifs_8c_a8c81aabb9b5fa55bad1c2ddb8d2ee6a9}{\index{motifs.\-c@{motifs.\-c}!get\-Volume@{get\-Volume}}
\index{get\-Volume@{get\-Volume}!motifs.c@{motifs.\-c}}
\subsubsection[{get\-Volume}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Volume (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp}
\end{DoxyParamCaption}
)}}\label{motifs_8c_a8c81aabb9b5fa55bad1c2ddb8d2ee6a9}
Permet d'afficher une volume de note param\mbox{[}out\mbox{]} m \-: motif dans lequel on affiche le volume de la note param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on affiche le volume de la note param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on affiche le volume de la note \hypertarget{motifs_8c_acd5428841ea3c29a618974d40bc9efe9}{\index{motifs.\-c@{motifs.\-c}!supprimer\-Motif@{supprimer\-Motif}}
\index{supprimer\-Motif@{supprimer\-Motif}!motifs.c@{motifs.\-c}}
\subsubsection[{supprimer\-Motif}]{\setlength{\rightskip}{0pt plus 5cm}void supprimer\-Motif (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$$\ast$}]{cellule, }
\item[{int}]{nbr\-Portees}
\end{DoxyParamCaption}
)}}\label{motifs_8c_acd5428841ea3c29a618974d40bc9efe9}
Permet de supprimer un motif
\begin{DoxyParams}[1]{Paramètres}
\mbox{\tt out} & {\em cellule} & \-: adresse de l'élément de la liste \\
\hline
\mbox{\tt in} & {\em nbr\-Portees} & \-: nombre de portées que l'on supprime \\
\hline
\end{DoxyParams}
\hypertarget{motifs_8c_aa74ce94a714f4487b60b3ddcac7bb645}{\index{motifs.\-c@{motifs.\-c}!supprimer\-Note@{supprimer\-Note}}
\index{supprimer\-Note@{supprimer\-Note}!motifs.c@{motifs.\-c}}
\subsubsection[{supprimer\-Note}]{\setlength{\rightskip}{0pt plus 5cm}void supprimer\-Note (
\begin{DoxyParamCaption}
\item[{{\bf Motif} $\ast$}]{m, }
\item[{int}]{portee, }
\item[{int}]{tmp}
\end{DoxyParamCaption}
)}}\label{motifs_8c_aa74ce94a714f4487b60b3ddcac7bb645}
Permet de supprimer une note param\mbox{[}out\mbox{]} m \-: motif dans lequel on supprime la note param\mbox{[}in\mbox{]} portee \-: portée du motif dans laquelle on supprime la note param\mbox{[}in\mbox{]} tmp \-: temps du motif dans lequel on supprime la note