ParameterView Class Reference

Main view. More...

#include <parameterview.h>

List of all members.

Public Slots

void addNewProgram ()
void loadProgram (KURL programUrl)
void removeProgram (ProgramPage *programPage)
void changeProgramName (ProgramPage *programPage, const QString &newName, QString message, QString title)
void nbChannelsModified (int nbChannels)
void nbSpikeGroupsModified (int nbGroups)
void fileModification (QValueList< QString > extensions)

Signals

void signalChangeStatusbar (const QString &text)
void resetModificationStatus ()
void partShown (Kate::View *view)
void partHidden ()
void nbSpikeGroupsHasBeenModified (int nbGroups)
void fileHasBeenModified (QValueList< QString > extensions)
void scriptListHasBeenModified (const QValueList< QString > &scriptNames)

Public Member Functions

 ParameterView (ndManager *mainWindow, ndManagerDoc &doc, QWidget *parent, const char *name, bool expertMode)
 ~ParameterView ()
void initialize (QMap< int, QValueList< int > > &anatomicalGroups, QMap< QString, QMap< int, QString > > &attributes, QMap< int, QValueList< int > > &spikeGroups, QMap< int, QMap< QString, QString > > &spikeGroupsInformation, QMap< int, QValueList< QString > > &units, GeneralInformation &generalInformation, QMap< QString, int > &acquisitionSystemInfo, QMap< QString, float > &videoInformation, QValueList< FileInformation > &files, QValueList< ChannelColors > &channelColors, QMap< int, int > &channelDefaultOffsets, NeuroscopeVideoInfo &neuroscopeVideoInfo, QValueList< ProgramInformation > &programs, int lfpRate, float screenGain, int nbSamples, int peakSampleIndex)
void getInformation (QMap< int, QValueList< int > > &anatomicalGroups, QMap< QString, QMap< int, QString > > &attributes, QMap< int, QValueList< int > > &spikeGroups, QMap< int, QMap< QString, QString > > &spikeGroupsInformation, QMap< int, QValueList< QString > > &units, GeneralInformation &generalInformation, QMap< QString, int > &acquisitionSystemInfo, QMap< QString, float > &videoInformation, QValueList< FileInformation > &files, QValueList< ChannelColors > &channelColors, QMap< int, int > &channelDefaultOffsets, NeuroscopeVideoInfo &neuroscopeVideoInfo, QValueList< ProgramInformation > &programs, int &lfpRate, float &screenGain, int &nbSamples, int &peakSampleIndex)
bool isModified ()
QValueList< QString > modifiedScripts ()
QValueList< QString > modifiedProgramDescription ()
void hasBeenSave ()
bool saveScript (QString programName)
void saveProgramDescription (QString programName)
int getNbGroups () const
QValueList< QString > getFileExtensions () const
const QValueList< QString > & getFileScriptNames () const


Detailed Description

Main view.

This is the main view class for ndManager. Most of the non-menu, non-toolbar, and non-statusbar (e.g., non frame) GUI code should go here.

Author:
Lynn Hazan <lynn.hazan@myrealbox.com>
Version:
0.1


Constructor & Destructor Documentation

ParameterView::ParameterView ( ndManager mainWindow,
ndManagerDoc doc,
QWidget *  parent,
const char *  name,
bool  expertMode 
)

Constructor

Parameters:
mainWindow a pointer on the main window of the application.
doc the document instance the view represents.
parent the parent QWidget.
name name of the widget (can be used for introspection).
expertMode true if the file is opened in expert mode, false otherwise.

ParameterView::~ParameterView (  ) 

Destructor


Member Function Documentation

void ParameterView::initialize ( QMap< int, QValueList< int > > &  anatomicalGroups,
QMap< QString, QMap< int, QString > > &  attributes,
QMap< int, QValueList< int > > &  spikeGroups,
QMap< int, QMap< QString, QString > > &  spikeGroupsInformation,
QMap< int, QValueList< QString > > &  units,
GeneralInformation generalInformation,
QMap< QString, int > &  acquisitionSystemInfo,
QMap< QString, float > &  videoInformation,
QValueList< FileInformation > &  files,
QValueList< ChannelColors > &  channelColors,
QMap< int, int > &  channelDefaultOffsets,
NeuroscopeVideoInfo neuroscopeVideoInfo,
QValueList< ProgramInformation > &  programs,
int  lfpRate,
float  screenGain,
int  nbSamples,
int  peakSampleIndex 
)

Initialize the parameter pages.

Parameters:
anatomicalGroups map given the composition of the anatomical groups. The trash group is not included, channels which are not part of any group are in the trash group.
attributes map given the correspondance between the attribute names and a map given for each channel the value of the attribute.
spikeGroups map given the composition of the spike groups. The trash and undefined groups are not included, channels which are not part of any group nor the trash group (this group is common to the anatomical and spike groups) are in the undefined group.
spikeGroupsInformation map containing the additional information for each spike group except the trash and undefined groups.
units map given the composition of the unit list.
generalInformation object storing the information contained in the General Information part of the parameter file.
acquisitionSystemInfo map given the information related to the acquisition system.
videoInformation map given the information related to the video recording system.
files list of object storing the information describing an additional file (filter and/or subset of the raw data file).
channelColors object storing the channel color information.
channelDefaultOffsets map storing the channel default offset information.
neuroscopeVideoInfo object storing the video information used by NeuroScope.
programs list of object storing the information describing a program to be used to process the raw data.
lfpRate rate of the local field potential file.
screenGain screen gain in milivolts by centimeters used to display the field potentiels in NeuroScope.
nbSamples the number of samples in a spike; value used by NeuroScope.
peakSampleIndex the sample index corresponding to the peak of the spike; value use dby NeuroScope

void ParameterView::getInformation ( QMap< int, QValueList< int > > &  anatomicalGroups,
QMap< QString, QMap< int, QString > > &  attributes,
QMap< int, QValueList< int > > &  spikeGroups,
QMap< int, QMap< QString, QString > > &  spikeGroupsInformation,
QMap< int, QValueList< QString > > &  units,
GeneralInformation generalInformation,
QMap< QString, int > &  acquisitionSystemInfo,
QMap< QString, float > &  videoInformation,
QValueList< FileInformation > &  files,
QValueList< ChannelColors > &  channelColors,
QMap< int, int > &  channelDefaultOffsets,
NeuroscopeVideoInfo neuroscopeVideoInfo,
QValueList< ProgramInformation > &  programs,
int &  lfpRate,
float &  screenGain,
int &  nbSamples,
int &  peakSampleIndex 
)

Gets the information from the parameter pages.

Parameters:
anatomicalGroups map given the composition of the anatomical groups. The trash group is not included, channels which are not part of any group are in the trash group.
attributes map given the correspondance between the attribute names and a map given for each channel the value of the attribute.
spikeGroups map given the composition of the spike groups. The trash and undefined groups are not included, channels which are not part of any group nor the trash group (this group is common to the anatomical and spike groups) are in the undefined group.
spikeGroupsInformation map containing the additional information for each spike group except the trash and undefined groups.
units map containing the composition of the unit list.
generalInformation object storing the information contained in the General Information part of the parameter file.
acquisitionSystemInfo map given the information related to the acquisition system.
videoInformation map given the information related to the video recording system.
files list of object storing the information describing an additional file (filter and/or subset of the raw data file).
channelColors object storing the channel color information.
channelDefaultOffsets map storing the channel default offset information.
neuroscopeVideoInfo object storing the video information used by NeuroScope.
programs list of object storing the information describing a program to be used to process the raw data.
lfpRate rate of the local field potential file.
screenGain screen gain in milivolts by centimeters used to display the field potentiels in NeuroScope.
nbSamples the number of samples in a spike; value used by NeuroScope.
peakSampleIndex the sample index corresponding to the peak of the spike; value use dby NeuroScope

bool ParameterView::isModified (  ) 

True if at least one parameter has been modified, false otherwise.

QValueList< QString > ParameterView::modifiedScripts (  ) 

Returns the list of the names of the programs for which the script is currently modified.

Returns:
list of the names of the programs having their script modified.

QValueList< QString > ParameterView::modifiedProgramDescription (  ) 

Returns the list of the names of the programs for which the program description is currently modified. The program description includes the program name, the number of parameters, their name and status, and the help.

Returns:
list of the names of the programs having their description modified.

void ParameterView::hasBeenSave (  ) 

Warns all the pages that the current state has been saved.

bool ParameterView::saveScript ( QString  programName  ) 

Saves the script programName.

Parameters:
programName name of the script to save.
Returns:
the saving status.

void ParameterView::saveProgramDescription ( QString  programName  ) 

Saves the description of the program programName.

Parameters:
programName name of the program description to save.

int ParameterView::getNbGroups (  )  const [inline]

Returns the current number of group of spikes.

QValueList<QString> ParameterView::getFileExtensions (  )  const [inline]

Returns a list containing all the extensions of the specific files.

Returns:
extension list.

const QValueList<QString>& ParameterView::getFileScriptNames (  )  const [inline]

Returns a list containing all the script names.

Returns:
script name list.

void ParameterView::signalChangeStatusbar ( const QString &  text  )  [signal]

This signal is used to change the content of the statusbar;

void ParameterView::resetModificationStatus (  )  [signal]

This signal is used to resets the internal modification status of all the pages to false.

void ParameterView::partShown ( Kate::View *  view  )  [signal]

This signal is used to update the menus and toolbars.

void ParameterView::partHidden (  )  [signal]

This signal is used to update the menus and toolbars.

void ParameterView::nbSpikeGroupsHasBeenModified ( int  nbGroups  )  [signal]

This signal is used to update the dropdown list containing the spike groups in the managerView.

void ParameterView::fileHasBeenModified ( QValueList< QString >  extensions  )  [signal]

This signal is used to update of the dropdown list containing the file extensions in the managerView.

void ParameterView::scriptListHasBeenModified ( const QValueList< QString > &  scriptNames  )  [signal]

This signal is used to update of the dropdown list containing the script names in the managerView.

void ParameterView::addNewProgram (  )  [slot]

Adds a new program to the subtree under the node Program.

void ParameterView::loadProgram ( KURL  programUrl  )  [slot]

Loads a program to the subtree under the node Program.

Parameters:
programUrl url of the file describing the program to load.

void ParameterView::removeProgram ( ProgramPage programPage  )  [slot]

Removes a program from the subtree under the node Program.

Parameters:
programPage the ProgramPage to remove.

void ParameterView::changeProgramName ( ProgramPage programPage,
const QString &  newName,
QString  message,
QString  title 
) [slot]

Changes the name of the program.

Parameters:
programPage the ProgramPage to rename.
newName the new name of the program.
message error message to use in case of an error while loading a new script.
title title of the possible error message box.

void ParameterView::nbChannelsModified ( int  nbChannels  )  [slot]

Triggers the changes in the different pages due to a modification of the number of channels.

Parameters:
nbChannels the new number of channels.

void ParameterView::nbSpikeGroupsModified ( int  nbGroups  )  [inline, slot]

Triggers the update of the dropdown list containing the spike groups in the managerView.

Parameters:
nbGroups the new number of spike groups.

void ParameterView::fileModification ( QValueList< QString >  extensions  )  [inline, slot]

Triggers the update of the dropdown list containing the file extensions in the managerView.

Parameters:
extensions list containing the extensions of all the specific files.


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