diff --git a/extrator/src/include/extratorVTT.h b/extrator/src/include/extratorVTT.h index f9d1819..ee39807 100644 --- a/extrator/src/include/extratorVTT.h +++ b/extrator/src/include/extratorVTT.h @@ -1,3 +1,10 @@ +/** + * \file extratorVTT.h + * + * \author Wesnydy Ribeiro + * \date 2015 + */ + #ifndef EXTRATORVTT_H #define EXTRATORVTT_H @@ -21,17 +28,47 @@ using namespace std; using namespace sndesc; using namespace jthread; +/** \brief Classe que implementa o extrator de legenda. +* +* Instâncias desta classe extraem o conteúdo de +* arquivos webVTT. +* +* \headerfile extrator/src/include/extratorVTT.h +*/ class ExtratorVTT: public Extrator, public Thread { public: + /** Construtor */ ExtratorVTT(); + + /** Destrutor */ ~ExtratorVTT(); + /** Define o path do arquivo de entrada. + * + * \param path O path do arquivo. + */ void setFilePath(char* path); + + /** Adiciona ouvintes do extratorVTT. + * + * \param listener O ouvinte a ser registrado. + */ void addListener(ListenerSub* listener); + /** Inicializa o processo de extração da legendas. + * + * \exception ExtratorException caso o arquivo de legenda não seja encontrado. + */ void initialize(); + + /** Indica o fim do processo de extração das legendas. + * + * \return O status do do processo. + */ bool isFinished(); + + /** Este método é chamado quando a Thread for iniciada. */ void Run(); private: -- libgit2 0.21.2