XmlReader Class Reference

#include <xmlreader.h>

List of all members.

Public Member Functions

bool parseFile (const KURL &url)
void closeFile ()
void getAcquisitionSystemInfo (QMap< QString, float > &acquisitionSystemInfo) const
void getAnatomicalDescription (int nbChannels, QMap< int, QValueList< int > > &anatomicalGroups, QMap< QString, QMap< int, QString > > &attributes)
void getSpikeDescription (int nbChannels, QMap< int, QValueList< int > > &spikeGroups, QMap< int, QMap< QString, QString > > &information)
void getUnits (QMap< int, QValueList< QString > > &units) const
void getGeneralInformation (GeneralInformation &generalInformation) const
void getVideoInfo (QMap< QString, float > &videoInformation) const
int getLfpInformation () const
void getFilesInformation (QValueList< FileInformation > &files) const
void getChannelColors (QValueList< ChannelColors > &list) const
float getScreenGain () const
void getNeuroscopeVideoInfo (NeuroscopeVideoInfo &videoInfo) const
void getChannelDefaultOffset (QMap< int, int > &channelDefaultOffsets) const
int getNbSamples () const
int getPeakSampleIndex () const
void getProgramsInformation (QValueList< ProgramInformation > &programs) const
void getProgramInformation (ProgramInformation &programInformation) const


Detailed Description

Author:
Lynn Hazan


Member Function Documentation

bool XmlReader::parseFile ( const KURL &  url  ) 

Opens and parses the file with the url.

Parameters:
url url of the file to open.
Returns:
true if the file was correctly parse, false othewise.

void XmlReader::closeFile (  ) 

Closes the currently open file.

void XmlReader::getAcquisitionSystemInfo ( QMap< QString, float > &  acquisitionSystemInfo  )  const

Gets all the information related to the acquisition system.

Parameters:
acquisitionSystemInfo map given the acquisition system information.

void XmlReader::getAnatomicalDescription ( int  nbChannels,
QMap< int, QValueList< int > > &  anatomicalGroups,
QMap< QString, QMap< int, QString > > &  attributes 
)

Gets the anatomical description: the groups and channel attributes.

Parameters:
nbChannels total number of channels.
anatomicalGroups reference to the map given the correspondance between the anatomical group ids and the channel ids.
attributes reference to the map given the correspondance between the attribute names and a map given for each channel the value of the attribute.

void XmlReader::getSpikeDescription ( int  nbChannels,
QMap< int, QValueList< int > > &  spikeGroups,
QMap< int, QMap< QString, QString > > &  information 
)

Gets the spike description: the groups and other type of information specific to a spike group (as the number of features).

Parameters:
nbChannels total number of channels.
spikeGroups reference to the map given the correspondance between the spike group ids and the channel ids.
information reference to the map given the correspondance between the spike group ids and a map given the name and the value of an additional information.

void XmlReader::getUnits ( QMap< int, QValueList< QString > > &  units  )  const

Gets a GeneralInformation containing all the general information. If a piece of information is not present, empty string is used as the value.

Parameters:
generalInformation a GeneralInformation to be filled.

void XmlReader::getGeneralInformation ( GeneralInformation generalInformation  )  const

Gets a GeneralInformation containing all the general information. If a piece of information is not present, empty string is used as the value.

Parameters:
generalInformation a GeneralInformation to be filled.

void XmlReader::getVideoInfo ( QMap< QString, float > &  videoInformation  )  const

Gets the video system information. If a piece of information is not present, a zero is return as the value.

Parameters:
videoInformation map given the video system information.

int XmlReader::getLfpInformation (  )  const

Returns the local field potential sampling rate in hertz.

Returns:
local field potential sampling rate in hertz.

void XmlReader::getFilesInformation ( QValueList< FileInformation > &  files  )  const

Gets the information for the additional files derive from the original raw data file (.dat file).

Parameters:
files a list of FileInformation to be filled.

void XmlReader::getChannelColors ( QValueList< ChannelColors > &  list  )  const

Gets the list of ChannelColors, class given the color for each channel.

Parameters:
list list of ChannelColors.

float XmlReader::getScreenGain (  )  const

Returns the screen gain in milivolts by centimeters used to display the field potentiels in NeuroScope, or zero if the element could not be found in the file.

Returns:
the screen gain.

void XmlReader::getNeuroscopeVideoInfo ( NeuroscopeVideoInfo videoInfo  )  const

Gets all the video information specific to NeuroScope.

Parameters:
videoInfo a NeuroscopeVideoInfo.

void XmlReader::getChannelDefaultOffset ( QMap< int, int > &  channelDefaultOffsets  )  const

Gets the map of Channel default offsets.

Parameters:
channelDefaultOffsets map given the channel default offsets.

int XmlReader::getNbSamples (  )  const

Returns the number of samples in a spike use by NeuroScope, or zero if the element could not be found in the file.

Note:
NeuroScope currently uses a unique value for all the spike groups.
Returns:
number of samples.

int XmlReader::getPeakSampleIndex (  )  const

Returns the sample index corresponding to the peak of the spike use by NeuroScope, or zero if the element could not be found in the file.

Note:
NeuroScope currently uses a unique value for all the spike groups.
Returns:
index.

void XmlReader::getProgramsInformation ( QValueList< ProgramInformation > &  programs  )  const

Gets the information for all the programs used to process the data link to the current parameter file.

Parameters:
programs a list of ProgramInformation to be filled.

void XmlReader::getProgramInformation ( ProgramInformation programInformation  )  const

Gets the information for one program used to process the data link to the current parameter file.

Parameters:
programInformation a ProgramInformation to be filled with the information concerning the program.


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