ghmm_document.h

一个通用的隐性马尔可夫C代码库 开发环境:C语言 简要说明:这是一个通用的隐性马尔可夫C代码库

/*
 * created: 14 Feb 2002 by Peter Pipenbacher
 * authors: Peter Pipenbacher ([e-mail])
 * file   : $Source: /cvsroot/ghmm/ghmm/ghmm++/GHMM_Document.h,v $
 * $Id: GHMM_Document.h,v 1.3 2003/02/28 15:09:16 wasinee Exp $
 *
 * Copyright (C) 1998-2001, ZAIK/ZPR, Universit鋞 zu K鰈n
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * 
 */

#ifndef _GHMM_DOCUMENT_H
#define _GHMM_DOCUMENT_H 1

#include <xmlio/XMLIO_Document.h>

#include <ghmm++/begin_code.h>

#ifdef HAVE_NAMESPACES
namespace std {
#endif

class GHMM_Document;
class GHMM_DiscreteModel;
class GHMM_ContinuousModel;
class GHMM_Sequences;


/** */
class GHMM_Document: public XMLIO_Document {

 public:

  enum enumModelType { NONE, GHMM_DISCRETE, GHMM_CONTINUOUS };

  /** Constructor. */
  GHMM_Document();
  /** Destructor. */
  virtual ~GHMM_Document();

  /** Returns continuous model, which has been read from file or NULL
      if no such model exists. */
  GHMM_ContinuousModel* getContinuousModel() const;
  /** Returns discrete model, which has been read from file or NULL
      if no such model exists. */
  GHMM_DiscreteModel* getDiscreteModel() const;
  /** Returns sequences, which has been read from file or NULL
      if no such model exists. */
  GHMM_Sequences* getSequences() const;

  /** Called by GHMM_Document when a start tag is received. Tag and 
      attributes are passed to this function. */
  virtual XMLIO_Element* XMLIO_startTag(const string& tag, XMLIO_Attributes &attrs);
  /** Called by XMLIO_Document when a end tag is found. 
      This happens when a sub element has finished reading its
      content. By default this function does nothing. */
  virtual void XMLIO_endTag(const string& tag);
  /** Writes the XML prolog (XML spec [22]).
      Only XMLDecl (XML specs [23]-[26]) is supported by calling XMLIO_writeXMLDeclaration()
      @return Returns nr of bytes written or an negative error code. */ 
  virtual int XMLIO_writeProlog();
  /** Is called when a document is closed and writes an optional trailer,
      which must be of Misc-type (XML specs [27]) after the main element 
      (XML specs [1]).
      By default this writes a newline character.
      @return Returns nr of bytes written or an negative error code. */ 
  virtual int XMLIO_writeTrailer();

  /** Returns name of class. */
  virtual const char* toString() const;


 protected:

  /** */
  GHMM_DiscreteModel* discrete_model;
  /** */
  GHMM_ContinuousModel* continuous_model;
  /** */
  GHMM_Sequences* sequences;
  /** */
  bool reading_ghmm;
  /** */
  enumModelType model_type;

};


#ifdef HAVE_NAMESPACES
}
#endif

#include <ghmm++/close_code.h>

#endif /* _GHMM_DOCUMENT_H */