xmm::Writable Class Reference

Abstract class for handling JSON + File I/O. More...

#include <xmmJson.hpp>

Inheritance diagram for xmm::Writable:

Public Member Functions
virtual	~Writable ()
Json I/O
virtual Json::Value	toJson () const =0
	Write the object to a JSON Structure. More...
virtual void	fromJson (Json::Value const &root)=0
	Read the object from a JSON Structure. More...
Python File I/O
void	writeFile (char *fileName) const
	write method for python wrapping ('write' keyword forbidden, name has to be different) More...
void	readFile (char *fileName)
	read method for python wrapping ('read' keyword forbidden, name has to be different) More...
std::string	__str__ () const
	"print" method for python => returns the results of write method More...

Detailed Description

Abstract class for handling JSON + File I/O.

the JSON I/O methods need to be implemented. writeFile and readFile methods can be used in Python for file I/O. The str() Python method is implemented to use with "print" in Python. It return the pretty-printed JSON String.

Constructor & Destructor Documentation

virtual xmm::Writable::~Writable ( )

inlinevirtual

Member Function Documentation

std::string xmm::Writable::__str__ ( ) const

inline

"print" method for python => returns the results of write method

Warning

only defined if SWIGPYTHON is defined

virtual void xmm::Writable::fromJson ( Json::Value const &  root )

pure virtual

Read the object from a JSON Structure.

Parameters

root	JSON value containing the object's information

Exceptions

JsonException

if the JSON value has a wrong format

Implemented in xmm::Model< SingleClassModel, ModelType >, xmm::Model< SingleClassHMM, HMM >, xmm::Model< SingleClassGMM, GMM >, xmm::Phrase, xmm::SingleClassProbabilisticModel, xmm::TrainingSet, xmm::GaussianDistribution, xmm::Configuration< ModelType >, xmm::Configuration< xmm::KMeans >, xmm::Configuration< GMM >, xmm::HierarchicalHMM, xmm::SingleClassHMM, xmm::SingleClassGMM, xmm::KMeans, xmm::SharedParameters, xmm::ClassParameters< KMeans >, and xmm::ClassParameters< GMM >.

void xmm::Writable::readFile ( char *  fileName )

inline

read method for python wrapping ('read' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

virtual Json::Value xmm::Writable::toJson ( ) const

pure virtual

Write the object to a JSON Structure.

Returns

Json value containing the object's information

Implemented in xmm::Model< SingleClassModel, ModelType >, xmm::Model< SingleClassHMM, HMM >, xmm::Model< SingleClassGMM, GMM >, xmm::Phrase, xmm::SingleClassProbabilisticModel, xmm::TrainingSet, xmm::GaussianDistribution, xmm::Configuration< ModelType >, xmm::Configuration< xmm::KMeans >, xmm::Configuration< GMM >, xmm::HierarchicalHMM, xmm::SingleClassHMM, xmm::SingleClassGMM, xmm::KMeans, xmm::SharedParameters, xmm::ClassParameters< KMeans >, and xmm::ClassParameters< GMM >.

void xmm::Writable::writeFile ( char *  fileName ) const

inline

write method for python wrapping ('write' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

---

The documentation for this class was generated from the following file:

• xmmJson.hpp