peakml.io.dac
Class DACExperimentInfo

java.lang.Object
  extended by peakml.io.dac.DACExperimentInfo

public class DACExperimentInfo
extends java.lang.Object

Collection of parameters and other information on the experiment.


Nested Class Summary
static class DACExperimentInfo.ExFunctionInfo
           
 
Constructor Summary
DACExperimentInfo()
           
 
Method Summary
 DACExperimentInfo.ExFunctionInfo getExFunctionInfo(int functionid)
           
 java.util.Vector<DACExperimentInfo.ExFunctionInfo> getExFunctionInfos()
           
 java.lang.String getExperimentText()
          Returns the free-text experiment text.
 int getNumFunctions()
          Returns the number of functions (or data-streams) associated to the given file.
 int open(java.lang.String filename)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DACExperimentInfo

public DACExperimentInfo()
Method Detail

open

public int open(java.lang.String filename)
Parameters:
The - file to open.
Returns:
RTCODE_SUCCESS when all is ok, RTCODE_FILE_NOT_FOUND when the file is not found.

getExperimentText

public java.lang.String getExperimentText()
Returns the free-text experiment text.

Returns:
The free-text experiment text

getNumFunctions

public int getNumFunctions()
Returns the number of functions (or data-streams) associated to the given file. This number should match that of DACFunctionInfo.getNumberOfFunctions(String); if this is not the case, the interpretation of the free-text has failed.

Returns:
The number of functions.

getExFunctionInfo

public DACExperimentInfo.ExFunctionInfo getExFunctionInfo(int functionid)
Parameters:
functionid - The function-id to collect the extended information for.
Returns:

getExFunctionInfos

public java.util.Vector<DACExperimentInfo.ExFunctionInfo> getExFunctionInfos()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object