Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends

alize::FeatureFileWriter Class Reference

#include <FeatureFileWriter.h>

Inheritance diagram for alize::FeatureFileWriter:
Inheritance graph
[legend]
Collaboration diagram for alize::FeatureFileWriter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 FeatureFileWriter (const FileName &f, const Config &c)
virtual void close ()
virtual ~FeatureFileWriter ()
virtual void writeFeature (const Feature &feature)
virtual String getClassName () const

Static Public Member Functions

static FeatureFileWritercreate (const FileName &f, const Config &c)

Private Member Functions

String getFullFileName (const Config &c, const String &n) const
 FeatureFileWriter (const FeatureFileWriter &)
const FeatureFileWriteroperator= (const FeatureFileWriter &)
bool operator== (const FeatureFileWriter &) const
bool operator!= (const FeatureFileWriter &) const

Private Attributes

FeatureFileWriterFormat _format
bool _vectSizeDefined
unsigned long _vectSize
unsigned long _featureCount
bool _headerWritten
const Config_config

Friends

class TestFeatureFileWriter

Detailed Description

Convenient class used to save a set of features in a file. In the RAW format, the dimension of the features is not saved. Each data of each feature is saved as a double float value (8 bytes). In the SPRO formats, the flags comes from the configuration. A raw file can be read using a FeatureFileReaderRaw object.

Author:
Frederic Wils frederic.wils@lia.univ-avignon.fr
Version:
1.0
Date:
2003

Definition at line 87 of file FeatureFileWriter.h.


Constructor & Destructor Documentation

W::FeatureFileWriter ( const FileName f,
const Config c 
) [explicit]

Create a new FeatureFileWriter object to save a set of features in a file

Parameters:
fthe file to write. No path is required. It uses the parameter "featureFilesPath" of the configuration.
cthe configuration to use

Definition at line 68 of file FeatureFileWriter.cpp.

W::~FeatureFileWriter (  ) [virtual]

Definition at line 192 of file FeatureFileWriter.cpp.

alize::FeatureFileWriter::FeatureFileWriter ( const FeatureFileWriter  ) [private]

Member Function Documentation

void W::close (  ) [virtual]

Closes the writer. A automatic call to close() is done when the writer is destroyed. But, if the file must be re-opened without destroying the writer, you MUST close the writer previously.

Exceptions:
IOExceptionif an I/O error occurs

Reimplemented from alize::FileWriter.

Definition at line 178 of file FeatureFileWriter.cpp.

References alize::FileWriter::close(), and alize::FeatureFileWriterFormat_SPRO3.

W & W::create ( const FileName f,
const Config c 
) [static]

See constructor with same parameters

Definition at line 73 of file FeatureFileWriter.cpp.

String W::getClassName (  ) const [virtual]

Returns the name of the class

Returns:
the name of the class of the object as a String

Reimplemented from alize::FileWriter.

Definition at line 190 of file FeatureFileWriter.cpp.

String W::getFullFileName ( const Config c,
const String n 
) const [private]
bool alize::FeatureFileWriter::operator!= ( const FeatureFileWriter  ) const [private]

Not implemented

const FeatureFileWriter& alize::FeatureFileWriter::operator= ( const FeatureFileWriter  ) [private]

Not implemented

bool alize::FeatureFileWriter::operator== ( const FeatureFileWriter  ) const [private]

Not implemented

void W::writeFeature ( const Feature feature ) [virtual]

Write a feature to the file

Parameters:
featurethe feature to save
Exceptions:
IOExceptionif an I/O error occurs
Exceptionif feature vectSize does not match previous features

Definition at line 88 of file FeatureFileWriter.cpp.

References alize::FeatureFileWriterFormat_RAW, alize::FeatureFileWriterFormat_SPRO3, alize::FeatureFileWriterFormat_SPRO4, alize::FeatureFlags::getString(), alize::Feature::getVectSize(), and alize::FeatureFlags::toSPro3().


Friends And Related Function Documentation

friend class TestFeatureFileWriter [friend]

Definition at line 89 of file FeatureFileWriter.h.


Member Data Documentation

Definition at line 134 of file FeatureFileWriter.h.

unsigned long alize::FeatureFileWriter::_featureCount [private]

Definition at line 132 of file FeatureFileWriter.h.

Definition at line 129 of file FeatureFileWriter.h.

Definition at line 133 of file FeatureFileWriter.h.

unsigned long alize::FeatureFileWriter::_vectSize [private]

Definition at line 131 of file FeatureFileWriter.h.

Definition at line 130 of file FeatureFileWriter.h.


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