XmlWriter Class Reference

#include <xmlwriter.h>

List of all members.

Public Member Functions

 XmlWriter ()
 ~XmlWriter ()
bool writeTofile (const KURL &url)
void setGeneralInformation (GeneralInformation &generalInformation)
void setAcquisitionSystemInformation (QMap< QString, float > &acquisitionSystemInfo)
void setVideoInformation (QMap< QString, float > &videoInformation)
void setLfpInformation (int lfpSamplingRate)
void setFilesInformation (QValueList< FileInformation > &files)
void setAnatomicalDescription (QMap< int, QValueList< int > > &anatomicalGroups, QMap< QString, QMap< int, QString > > &attributes)
void setSpikeDetectionInformation (QMap< int, QValueList< int > > &spikeGroups, QMap< int, QMap< QString, QString > > &information)
void setMiscellaneousInformation (float screenGain)
void setNeuroscopeVideoInformation (NeuroscopeVideoInfo &videoInfo)
void setNeuroscopeSpikeInformation (int nbSamples, int peakSampleIndex)
void setChannelDisplayInformation (QValueList< ChannelColors > &colorList, QMap< int, int > &channelDefaultOffsets)
void setProgramsInformation (QValueList< ProgramInformation > &programs)
void setUnitsInformation (QMap< int, QValueList< QString > > &units)


Detailed Description

This class writes the parameter file to disk.

Author:
Lynn Hazan


Constructor & Destructor Documentation

XmlWriter::XmlWriter (  ) 

Constructor.

XmlWriter::~XmlWriter (  ) 

Destructor.


Member Function Documentation

bool XmlWriter::writeTofile ( const KURL &  url  ) 

Writes the xml tree to a parameter file given by url.

Parameters:
url url of the file to write to.
Returns:
true if the parameter file could be write to disk, false otherwise.

void XmlWriter::setGeneralInformation ( GeneralInformation generalInformation  ) 

Creates the element containing all the general information.

Parameters:
generalInformation reference to ageneralInformation a GeneralInformation containing all the information.

void XmlWriter::setAcquisitionSystemInformation ( QMap< QString, float > &  acquisitionSystemInfo  ) 

Creates the elements related to the acquisition system.

Parameters:
acquisitionSystemInfo reference to a map acquisitionSystemInfo providing the acquisition system information.

void XmlWriter::setVideoInformation ( QMap< QString, float > &  videoInformation  ) 

Creates the elements containing the video information.

Parameters:
videoInformation reference to the map providing the video system information.

void XmlWriter::setLfpInformation ( int  lfpSamplingRate  ) 

Creates the element related to the field potentials.

Parameters:
lfpSamplingRate local field potential sampling rate in hertz.

void XmlWriter::setFilesInformation ( QValueList< FileInformation > &  files  ) 

Creates the elements containing the information for the additional files derive from the original raw data file (.dat file).

Parameters:
files a reference to a list of FileInformation.

void XmlWriter::setAnatomicalDescription ( QMap< int, QValueList< int > > &  anatomicalGroups,
QMap< QString, QMap< int, QString > > &  attributes 
)

Creates the elements related to the anatomical description.

Parameters:
anatomicalGroups reference to a map providing information about the anatomical group to which each channel belongs.
attributes reference to a map providing the correspondance between the attribute names and a map providing for each channel the value of the attribute.

void XmlWriter::setSpikeDetectionInformation ( QMap< int, QValueList< int > > &  spikeGroups,
QMap< int, QMap< QString, QString > > &  information 
)

Creates the elements related to the spike detection.

Parameters:
spikeGroups reference to the map providing the correspondance between the spike group ids and the channel ids.
information reference to the map providing the correspondance between the spike group ids and a map providing the name and the value of an additional information.

void XmlWriter::setMiscellaneousInformation ( float  screenGain  ) 

Creates the elements containing NeuroScope miscellaneous information.

Parameters:
screenGain screen gain in millivolts by centimeters used to display the field potentiels.

void XmlWriter::setNeuroscopeVideoInformation ( NeuroscopeVideoInfo videoInfo  ) 

Creates the elements containing the video information used in NeuroScope.

Parameters:
videoInfo reference to a NeuroscopeVideoInfo.

void XmlWriter::setNeuroscopeSpikeInformation ( int  nbSamples,
int  peakSampleIndex 
)

Creates the elements containing the spike information used in NeuroScope.

Parameters:
nbSamples number of samples in a spike.
peakSampleIndex sample index corresponding to the peak of the spike.

void XmlWriter::setChannelDisplayInformation ( QValueList< ChannelColors > &  colorList,
QMap< int, int > &  channelDefaultOffsets 
)

Creates the elements related to the channels colors used in NeuroScope.

Parameters:
colorList reference to a list of ChannelColors (color use to display the channel, color of the anatomical group to which the channel belongs, color of the spike group to which the channel belongs).
channelDefaultOffsets reference to a map providing channel default offsets.

void XmlWriter::setProgramsInformation ( QValueList< ProgramInformation > &  programs  ) 

Creates the elements containing the information for all the programs used to process the data link to the current parameter file.

Parameters:
programs a reference to a list of ProgramInformation.

void XmlWriter::setUnitsInformation ( QMap< int, QValueList< QString > > &  units  ) 

Creates the elements containing the information for units.

Parameters:
units a reference to a map providing the units information.


The documentation for this class was generated from the following files:
Generated on Sat Sep 15 16:04:46 2007 for ndmanager.kdevelop by  doxygen 1.5.1