%
% API Documentation
% Module fs_stat
%
% Generated by epydoc 2.1
% [Wed Oct 26 19:48:55 2005]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{fs\_stat \textit{(module)}|(}
\section{Module fs\_stat}

    \label{fs_stat}
module written to compute stat on a filesytem

    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}|(}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{Class pc\_fs\_stat}

    \label{fs_stat:pc_fs_stat}
class written to give stat about a filesystem


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \label{fs_stat:pc_fs_stat:__init__}
    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}!\_\_init\_\_ \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{pc\_fs})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    initialisation of the object pc\_fs is the filesystem on which we 
    will make stat

    \vspace{1ex}

    \end{boxedminipage}

    \label{fs_stat:pc_fs_stat:parse_document}
    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}!parse\_document \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{parse\_document}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    to detect the document

    \vspace{1ex}

    \end{boxedminipage}

    \label{fs_stat:pc_fs_stat:stat_document}
    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}!stat\_document \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{stat\_document}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return the stat document the result is something like that : 
    \{"doc":"avg\_size":4,"min\_size":2,........ , "pdf":\}\}

    \vspace{1ex}

    \end{boxedminipage}

    \label{fs_stat:pc_fs_stat:stat_documents_facto}
    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}!stat\_documents\_facto \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{stat\_documents\_facto}(\textit{self}, \textit{parameter}, \textit{nb}, \textit{ext})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    internal function : fill compute the stat for the document with ext 
    ext about the size or the date parameter is in ["size","date"] nb is 
    the number of document ext is the exention of the document

    \vspace{1ex}

    \end{boxedminipage}

    \label{fs_stat:pc_fs_stat:stat_rep}
    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}!stat\_rep \textit{(method)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{stat\_rep}(\textit{self}, \textit{rep})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return stat (size and nb file) about a directory the result is 
    (count,size)

    \vspace{1ex}

    \end{boxedminipage}

    \index{fs\_stat \textit{(module)}!pc\_fs\_stat \textit{(class)}|)}
    \index{fs\_stat \textit{(module)}|)}