MetaData Class Reference

#include <metadata.h>

Inheritance diagram for MetaData:

Collaboration diagram for MetaData:

Public Slots
int	dialog (void)
void	presetDialog (void)

Public Member Functions
	MetaData (RELACSWidget *rw)
	~MetaData (void)
virtual void	notify (void)
void	update (void)
void	add (const string &title="", const Options &opts=Options())
void	remove (void)
void	save (void)
ostream &	saveXML (ostream &str, int level=0, const string &name="")
void	clear (void)
void	add (ConfigClass *opt)
void	lock (void) const
void	unlock (void) const
QMutex *	mutex (void)
void	addActions (QMenu *menu)
int	saveFlags (void) const
void	setSaveFlags (int flags)
void	addSaveFlags (int flags)
void	delSaveFlags (int flags)
Public Member Functions inherited from Options
	Options (void)
	Options (const Options &o)
	Options (const Options &o, int flags)
	Options (const string &name, const string &type, int flags, int style)
	Options (const Str &opttxt, const string &assignment=":=", const string &separator=",;")
	Options (const StrQueue &sq, const string &assignment=":=")
	Options (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", string *line=0)
virtual	~Options (void)
Options &	operator= (const Options &o)
Options &	assign (const Options &o)
Options &	append (const Options &o)
Options &	add (const Options &o)
Options &	insert (const Options &o, const string &atname="")
Options &	assign (const Options &o, int flags)
Options &	copy (Options &o, int flags)
Options &	append (const Options &o, int flags)
Options &	add (const Options &o, int flags)
Options &	insert (const Options &o, int flags, const string &atname="")
Parameter *	assign (const string &name, const string &value)
Options *	parentSection (void)
const Options *	parentSection (void) const
void	setParentSection (Options *parentsection)
void	resetParents (void)
Options *	rootSection (void)
const Options *	rootSection (void) const
string	name (void) const
virtual void	setName (const string &name)
virtual void	setName (const string &name, const string &type)
string	type (void) const
void	setType (const string &type)
string	include (void) const
void	setInclude (const string &include)
void	setInclude (const string &url, const string &name)
int	flag (void) const
bool	flag (int selectflag) const
Options &	setFlag (int flag)
Options &	addFlag (int flag)
Options &	delFlag (int flag)
Options &	clearFlag (void)
int	style (void) const
Options &	setStyle (int style)
Options &	addStyle (int style)
Options &	delStyle (int style)
Options &	clearStyle (void)
bool	checkType (int mask) const
Str	warning (void) const
iterator	begin (void)
iterator	end (void)
const_iterator	begin (void) const
const_iterator	end (void) const
section_iterator	sectionsBegin (void)
section_iterator	sectionsEnd (void)
const_section_iterator	sectionsBegin (void) const
const_section_iterator	sectionsEnd (void) const
const_iterator	find (const string &pattern, int level=-1) const
iterator	find (const string &pattern, int level=-1)
const_iterator	rfind (const string &pattern, int level=-1) const
iterator	rfind (const string &pattern, int level=-1)
const_section_iterator	findSection (const string &pattern, int level=-1) const
section_iterator	findSection (const string &pattern, int level=-1)
const_section_iterator	rfindSection (const string &pattern, int level=-1) const
section_iterator	rfindSection (const string &pattern, int level=-1)
const Parameter &	operator[] (int i) const
Parameter &	operator[] (int i)
const Parameter &	operator[] (const string &name) const
Parameter &	operator[] (const string &name)
const Options &	section (int i) const
Options &	section (int i)
const Options &	section (const string &name) const
Options &	section (const string &name)
Str	request (const string &name) const
Parameter &	setRequest (const string &name, const string &request)
Parameter::ValueType	valueType (const string &name) const
Parameter &	setValueType (const string &name, Parameter::ValueType type)
int	flags (const string &name) const
bool	flags (const string &name, int flag) const
Parameter &	setFlags (const string &name, int flags)
Parameter &	addFlags (const string &name, int flags)
Parameter &	delFlags (const string &name, int flags)
Parameter &	clearFlags (const string &name)
bool	changed (const string &name)
int	style (const string &name) const
Parameter &	setStyle (const string &name, int style)
Parameter &	addStyle (const string &name, int style)
Parameter &	delStyle (const string &name, int style)
Str	format (const string &name) const
Parameter &	setFormat (const string &name, int width=0, int prec=-1, char fmt='g')
Parameter &	setFormat (const string &name, const string &format)
int	formatWidth (const string &name) const
int	size (const string &name) const
Parameter &	add (const Parameter &np)
Parameter &	insert (const Parameter &np, const string &atname="")
Parameter &	addText (const string &name, const string &request, const string &dflt, int flags=0, int style=0)
Parameter &	addText (const string &name, const string &dflt="", int flags=0, int style=0)
Parameter &	insertText (const string &name, const string &atname, const string &request, const string &dflt, int flags=0, int style=0)
Parameter &	insertText (const string &name, const string &atname="", const string &dflt="", int flags=0, int style=0)
Str	text (const string &name, int index, const string &dflt="", const string &format="", const string &unit="") const
Str	text (const string &name, const string &dflt="", const string &format="", const string &unit="") const
void	texts (const string &name, vector< string > &s, const string &format="", const string &unit="") const
Str	allText (const string &name, const string &dflt="", const string &format="", const string &unit="", const string &separator=", ") const
Parameter &	setText (const string &name, const string &strg)
Parameter &	setText (const string &name, const Parameter &p)
Parameter &	pushText (const string &name, const string &strg)
Str	defaultText (const string &name, const string &format="", const string &unit="") const
Parameter &	setDefaultText (const string &name, const string &dflt)
Parameter &	addSelection (const string &name, const string &request, const string &selection, int flags=0, int style=0)
Parameter &	addSelection (const string &name, const string &selection="", int flags=0, int style=0)
Parameter &	insertSelection (const string &name, const string &atname, const string &request, const string &selection, int flags=0, int style=0)
Parameter &	insertSelection (const string &name, const string &atname="", const string &selection="", int flags=0, int style=0)
Parameter &	selectText (const string &name, const string &strg, int add=0)
Parameter &	selectText (const string &name, int index)
int	index (const string &name) const
int	index (const string &name, const string &strg) const
Parameter &	addNumber (const string &name, const string &request, double dflt, double minimum, double maximum=MAXDOUBLE, double step=1.0, const string &unit="", const string &outputunit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, double dflt, const string &unit, int flags, int style=0)
Parameter &	addNumber (const string &name, double dflt, double error, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, const string &request, double dflt, double minimum, double maximum=MAXDOUBLE, double step=1.0, const string &unit="", const string &outputunit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, const string &unit="", const string &format="", int flags=0, int style=0)
double	number (const string &name, double dflt=0.0, const string &unit="", int index=0) const
double	number (const string &name, const string &unit, double dflt=0.0, int index=0) const
double	number (const string &name, int index, double dflt=0.0, const string &unit="") const
double	number (const string &name, int index, const string &unit, double dflt=0.0) const
void	numbers (const string &name, vector< double > &n, const string &unit="") const
double	error (const string &name, const string &unit="", int index=0) const
double	error (const string &name, int index, const string &unit="") const
void	errors (const string &name, vector< double > &n, const string &unit="") const
Parameter &	setNumber (const string &name, double number, double error, const string &unit="")
Parameter &	setNumber (const string &name, double number, const string &unit="")
Parameter &	pushNumber (const string &name, double number, double error=-1.0, const string &unit="")
Parameter &	pushNumber (const string &name, double number, const string &unit)
Parameter &	setNumber (const string &name, const Parameter &p)
double	defaultNumber (const string &name, const string &unit="") const
Parameter &	setDefaultNumber (const string &name, double dflt, const string &unit="")
double	minimum (const string &name, const string &unit="") const
double	maximum (const string &name, const string &unit="") const
double	step (const string &name, const string &unit="") const
Parameter &	setStep (const string &name, double step, const string &unit="")
Parameter &	setMinMax (const string &name, double minimum=-MAXDOUBLE, double maximum=MAXDOUBLE, double step=1.0, const string &unit="")
Str	unit (const string &name) const
Str	outUnit (const string &name) const
Parameter &	setUnit (const string &name, const string &internunit, const string &outunit="")
Parameter &	setOutUnit (const string &name, const string &outputunit)
Parameter &	changeUnit (const string &name, const string &internunit)
Parameter &	addInteger (const string &name, const string &request, long dflt, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="", const string &outputunit="", int width=0, int flags=0, int style=0)
Parameter &	addInteger (const string &name, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
Parameter &	addInteger (const string &name, const string &unit="")
Parameter &	insertInteger (const string &name, const string &atname, const string &request, long dflt, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="", const string &outputunit="", int width=0, int flags=0, int style=0)
Parameter &	insertInteger (const string &name, const string &atname, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
Parameter &	insertInteger (const string &name, const string &atname, const string &unit="", int width=0, int flags=0, int style=0)
long	integer (const string &name, const string &unit="", long dflt=0, int index=0) const
long	integer (const string &name, int index, long dflt=0, const string &unit="") const
long	integer (const string &name, int index, const string &unit, long dflt=0) const
void	integers (const string &name, vector< long > &n, const string &unit="") const
void	integers (const string &name, vector< int > &n, const string &unit="") const
Parameter &	setInteger (const string &name, long number, long error, const string &unit="")
Parameter &	setInteger (const string &name, long number, const string &unit="")
Parameter &	pushInteger (const string &name, long number, long error, const string &unit="")
Parameter &	pushInteger (const string &name, long number, const string &unit="")
Parameter &	setInteger (const string &name, const Parameter &p)
long	defaultInteger (const string &name, const string &unit="") const
Parameter &	setDefaultInteger (const string &name, long dflt, const string &unit="")
Parameter &	setMinMax (const string &name, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="")
Parameter &	setMinMax (const string &name, int minimum, int maximum, int step=1, const string &unit="")
Parameter &	addBoolean (const string &name, const string &request, bool dflt, int flags=0, int style=0)
Parameter &	addBoolean (const char *name, const char *request, bool dflt, int flags=0, int style=0)
Parameter &	addBoolean (const string &name, bool dflt, int flags=0, int style=0)
Parameter &	addBoolean (const char *name, bool dflt, int flags=0, int style=0)
Parameter &	insertBoolean (const string &name, const string &atname="", const string &request="", bool dflt=false, int flags=0, int style=0)
Parameter &	insertBoolean (const string &name, const string &atname, int flags=0, int style=0)
bool	boolean (const string &name, bool dflt=false, int index=0) const
bool	boolean (const string &name, int index, bool dflt=false) const
void	booleans (const string &name, vector< bool > &n) const
Parameter &	setBoolean (const string &name, bool b)
Parameter &	setBoolean (const string &name, const Parameter &p)
bool	defaultBoolean (const string &name) const
Parameter &	setDefaultBoolean (const string &name, bool dflt)
Parameter &	addDate (const string &name, const string &request, int year=0, int month=0, int day=0, int flags=0, int style=0)
Parameter &	addDate (const string &name, int year, int month, int day, int flags=0, int style=0)
Parameter &	addDate (const string &name, int flags=0, int style=0)
Parameter &	insertDate (const string &name, const string &atname="", const string &request="", int year=0, int month=0, int day=0, int flags=0, int style=0)
Parameter &	insertDate (const string &name, const string &atname, int year=0, int month=0, int day=0, int flags=0, int style=0)
Parameter &	insertDate (const string &name, const string &atname, int flags=0, int style=0)
const Parameter &	date (const string &name, int index, int &year, int &month, int &day) const
Parameter &	setDate (const string &name, int year, int month, int day)
Parameter &	setDate (const string &name, const string &date)
Parameter &	setDate (const string &name, const struct tm &date)
Parameter &	setDate (const string &name, const time_t &time)
Parameter &	setCurrentDate (const string &name)
Parameter &	setDate (const string &name, const Parameter &p)
const Parameter &	defaultDate (const string &name, int index, int &year, int &month, int &day) const
Parameter &	setDefaultDate (const string &name, int year, int month, int day)
Parameter &	addTime (const string &name, const string &request, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
Parameter &	addTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0, int flags=0, int style=0)
Parameter &	addTime (const string &name, int flags=0, int style=0)
Parameter &	insertTime (const string &name, const string &atname="", const string &request="", int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
Parameter &	insertTime (const string &name, const string &atname, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
Parameter &	insertTime (const string &name, const string &atname, int flags=0, int style=0)
const Parameter &	time (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
Parameter &	setTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
Parameter &	setTime (const string &name, const string &time)
Parameter &	setTime (const string &name, const struct tm &time)
Parameter &	setTime (const string &name, const time_t &time)
Parameter &	setCurrentTime (const string &name)
Parameter &	setTime (const string &name, const Parameter &p)
const Parameter &	defaultTime (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
Parameter &	setDefaultTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
Options &	newSection (int level, const string &name, const string &type="", int flag=0, int style=0)
Options &	newSection (int level, const string &name, int flag, int style=0)
Options &	newSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	newSection (const string &name, int flag, int style=0)
Options &	newSubSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	newSubSection (const string &name, int flag, int style=0)
Options &	newSubSubSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	newSubSubSection (const string &name, int flag, int style=0)
Options &	addSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	addSection (const string &name, int flag, int style=0)
Options &	insertSection (const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
Options &	insertSection (const string &name, const string &atpattern, int flag, int style=0)
Options &	newSection (int level, const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (int level, const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (int level, const Options &opt, const string &name, int flag, int style=0)
Options &	newSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (const Options &opt, const string &name, int flag, int style=0)
Options &	newSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSection (const Options &opt, const string &name, int flag, int style=0)
Options &	newSubSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSubSection (const Options &opt, const string &name, int flag, int style=0)
Options &	addSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	addSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	addSection (const Options &opt, const string &name, int flag, int style=0)
Options &	insertSection (const Options &opt, int selectmask, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
Options &	insertSection (const Options &opt, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
Options &	insertSection (const Options &opt, const string &name, const string &atpattern, int flag, int style=0)
Options &	newSection (Options *opt, bool newparent=false)
Options &	addSection (Options *opt, bool newparent=false)
Options &	insertSection (Options *opt, const string &atpattern, bool newparent=false)
Options &	newSections (Options *opt, bool newparent=false)
void	endSection (void)
void	clearSections (void)
void	setSection (Options &opt)
void	lastSection (void)
int	up (void)
int	down (void)
Parameter &	setDefault (const string &name)
Options &	setDefaults (int flags=0)
Parameter &	setToDefault (const string &name)
Options &	setToDefaults (int flags=0)
Options &	erase (iterator p)
Options &	erase (section_iterator p)
Options &	erase (Options *s)
Options &	erase (const string &pattern)
Options &	erase (int selectflag)
Options &	pop (void)
Options &	popSection (void)
Options &	flatten (Options *root=0)
Options &	clear (bool revert=true)
int	size (void) const
int	size (int selectflag) const
bool	empty (void) const
int	parameterSize (void) const
int	parameterSize (int flags) const
int	sectionsSize (void) const
int	sectionsSize (int flags) const
bool	exist (const string &pattern) const
bool	existSection (const string &pattern) const
Options &	setFlags (int flags, int selectflag=0)
Options &	addFlags (int flags, int selectflag=0)
Options &	delFlags (int flags, int selectflag=0)
Options &	setValueTypeFlags (int flags, int typemask)
Options &	addValueTypeFlags (int flags, int typemask)
Options &	delValueTypeFlags (int flags, int typemask)
Options &	setStyles (int style, int selectflag=0)
Options &	addStyles (int style, int selectflag=0)
Options &	delStyles (int style, int selectflag=0)
int	styleSize (int style) const
Options &	setValueTypeStyles (int style, int typemask)
Options &	addValueTypeStyles (int style, int typemask)
Options &	delValueTypeStyles (int style, int typemask)
int	nameWidth (int selectmask=0, bool detailed=false, bool escape=false) const
string	save (int selectmask=0, int flags=0) const
ostream &	save (ostream &str, const string &start="", int selectmask=0, int flags=0, int width=-1) const
ostream &	save (ostream &str, const string &textformat, const string &numberformat, const string &boolformat="%i=%b", const string &dateformat="%i=%04Y-%02m-%02d", const string &timeformat="%i=%02H:%02M:%02S", const string &sectionformat="%i", int selectmask=0, const string &start="") const
ostream &	saveXML (ostream &str, int selectmask=0, int flags=0, int level=0, int indent=4) const
Options &	read (const string &opttxt, int flag, const string &assignment=":=", const string &separator=",;", int *indent=0)
Options &	read (const string &opttxt, const string &assignment=":=", const string &separator=",;")
istream &	read (istream &str, int flag, const string &assignment=":=", const string &comment="#", const string &stop="", Str *line=0)
istream &	read (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", Str *line=0)
Options &	read (const StrQueue &sq, int flag=0, const string &assignment=":=")
bool	read (const Parameter &p, int flag=0)
Options &	read (const Options &o, int flags=0, int flag=0)
bool	readAppend (const Parameter &p)
Options &	readAppend (const Options &o, int flags=0)
Options &	load (const Str &opttxt, const string &assignment=":=", const string &separator=",;", int *indent=0, int *indentspacing=0, int *level=0)
istream &	load (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", string *line=0)
Options &	load (const StrQueue &sq, const string &assignment=":=")
void	callNotifies (void)
bool	setNotify (bool notify=true)
bool	unsetNotify (void)
bool	notifying (void) const

Static Public Member Functions
static int	dialogFlag (void)
static int	presetDialogFlag (void)
static int	configFlag (void)
static int	standardFlag (void)
Static Public Member Functions inherited from Options
static double	floorLog10 (double v)
static double	floor10 (double v, double scale=1.0)
static double	ceil10 (double v, double scale=1.0)

Protected Slots
void	dialogClosed (int r)

Protected Member Functions
virtual void	customEvent (QEvent *qe)
void	setSectionName (Options *opt, const string &name)

Additional Inherited Members
Public Types inherited from Options
enum	SaveFlags {   NoName = 1, NoType = 2, NoInclude = 4, SwitchNameType = 8,   Embrace = 16, PrintRequest = 32, FirstOnly = 64, PrintType = 128,   PrintStyle = 256, DontCloseSection = 512, AlwaysQuote = 1024, EscapeQuotes = 2048 }
typedef deque< Parameter > ::iterator	iterator
typedef deque< Parameter > ::const_iterator	const_iterator
typedef deque< Options * > ::iterator	section_iterator
typedef deque< Options * > ::const_iterator	const_section_iterator
Static Public Attributes inherited from Options
static const int	NonDefault = Parameter::NonDefault
static const long	TabSection = 0x04000000

Detailed Description

Manages meta data describing a recording session.

Author

Jan Benda

Meta data are loaded from both the relacs.cfg and the relacsplugins.cfg file (after Control::initialize() and before Control::initDevices() is called) via two instances of the MetaDataGroup class.

Never add options to MetaData within a Control constructor, since these get cleared right before the meta data are loaded from the configuration files!

With the dialogFlag() and the presetDialogFlag() meta data can be selected that are displayed in the dialog() or presetDialog(), respectively.

The "Recording" section is always created by MetaData and contains a few standard properties. A couple of predifined properties are defined in the Recording section:

• File: the base path for all the files saved by the recording session
• Date: the date of the recording session
• Time: the time when the recording session ended
• Recording duration: the duration of the recording session
• Mode: "experiment" or "simulation"
• Software: "RELACS"
• Software version: the RELACS version number All these standard options have the MetaData::standardFlag() set.

The values of the standard options are set appropriately in save() right before they are saved to the info file of the session.

If you really want you can remove individual standard options in Control::config() by doing something like

metaData( "Recording" ).erase( "File" );

Constructor & Destructor Documentation

MetaData

(

RELACSWidget *

rw

)

References MetaData::clear().

~MetaData

(

void

)

Member Function Documentation

void notify ( void  )

virtual

React to changes in the meta data sections. This function calls notifyMetaData() in all RELACSPlugins.

Reimplemented from Options.

References RELACSWidget::notifyMetaData().

void update

(

void

)

Update the values of the standarad meta data. Should be called before save().

References Str::expandedPath(), Options::findSection(), MetaData::lock(), RELACSWidget::modeStr(), Str::name(), SaveFiles::path(), Options::sectionsEnd(), Session::sessionTime(), Session::startSessionTime(), and MetaData::unlock().

Referenced by RELACSWidget::stopSession().

void add	(	const string &	title = "",
		const Options &	opts = Options()
	)

Add the meta data opts with title title as a section to the meta data, if both of them are not empty.

See Also

remove()

References Options::addFlags(), Options::empty(), MetaData::lock(), Options::newSection(), MetaData::saveFlags(), and MetaData::unlock().

Referenced by DataFile::add(), DataFile::readBlock(), MetaDataGroup::readConfig(), and RELACSWidget::stopSession().

void remove

(

void

)

Remove an added section from the metadata.

See Also

update()

References Options::erase(), MetaData::lock(), and MetaData::unlock().

Referenced by RELACSWidget::stopSession().

void save

(

void

)

Saves the meta data of all sections into the info file of the session.

References SaveFiles::addPath(), Options::FirstOnly, MetaData::lock(), ConfigDialog::lock(), Options::NoType, Options::save(), MetaData::saveFlags(), Options::text(), MetaData::unlock(), and ConfigDialog::unlock().

Referenced by RELACSWidget::stopSession().

ostream & saveXML	(	ostream &	str,
		int	level = 0,
		const string &	name = ""
	)

Write meta data that have saveFlags() set in their flags() in XML format to output stream.

Parameters

[in]	str	the output stream
[in]	level	the level of indentation
[in]	name	the name prefix for the name tag of the section.

Returns

the output stream str

References Options::FirstOnly, MetaData::lock(), MetaData::saveFlags(), Options::saveXML(), MetaData::setSectionName(), Options::SwitchNameType, and MetaData::unlock().

Referenced by SaveFiles::ODMLFiles::close().

void clear

(

void

)

Clear the entire meta data.

References MetaDataGroup::clear(), Options::clear(), MetaData::lock(), and MetaData::unlock().

Referenced by RELACSWidget::clearActivity(), DataFile::close(), RELACSWidget::init(), DataFile::initData(), MetaData::MetaData(), and RELACSWidget::startIdle().

void add

(

ConfigClass *

opt

)

Notify MetaData about loaded meta data opt.

References Options::clear(), ConfigClass::configGroup(), RELACSPlugin::Core, Options::name(), Options::newSection(), Options::newSections(), and Options::sectionsSize().

void lock

(

void

)

const

Lock the meta data.

Referenced by MetaData::add(), SaveFiles::addFile(), MetaData::clear(), MetaDataGroup::configSize(), RELACSPlugin::lockMetaData(), MetaDataGroup::readConfig(), MetaData::remove(), MetaData::save(), MetaDataGroup::saveConfig(), MetaData::saveXML(), and MetaData::update().

void unlock

(

void

)

const

Unlock the meta data.

Referenced by MetaData::add(), SaveFiles::addFile(), MetaData::clear(), MetaDataGroup::configSize(), MetaData::dialog(), MetaData::presetDialog(), MetaDataGroup::readConfig(), MetaData::remove(), MetaData::save(), MetaDataGroup::saveConfig(), MetaData::saveXML(), RELACSPlugin::unlockMetaData(), and MetaData::update().

QMutex * mutex

(

void

)

The mutex of the meta data.

Referenced by RELACSPlugin::metaDataMutex().

void addActions

(

QMenu *

menu

)

Add actions to the RELACS menu.

References MetaData::presetDialog().

Referenced by RELACSWidget::RELACSWidget().

int dialogFlag ( void  )

static

The flag that is used to mark meta data options for the dialog.

Referenced by MetaData::dialog(), MetaData::presetDialog(), and MetaDataGroup::readConfig().

int presetDialogFlag ( void  )

static

The flag that is used to mark meta data options for the preset dialog.

Referenced by MetaData::presetDialog().

int configFlag ( void  )

static

The flag that is used by MetaDataGroup::readConfig() to mark meta data options loaded from the config file.

Referenced by MetaDataGroup::configSize(), MetaDataGroup::MetaDataGroup(), MetaDataGroup::readConfig(), and MetaDataGroup::saveConfig().

int standardFlag ( void  )

static

The flag that is used to mark the standard options.

Referenced by SaveFiles::addFile(), and MetaDataGroup::addRecordingOptions().

int saveFlags

(

void

)

const

The flags that are used to select meta-data Options to be saved in the info file of the session (default (=0) selects all).

Referenced by MetaData::add(), MetaData::save(), and MetaData::saveXML().

void setSaveFlags

(

int

flags

)

Set the flags that are used to select meta-data Options to be saved in the info file of the session to flags. Setting flags to 0 selects all (default).

References Options::flags().

void addSaveFlags

(

int

flags

)

Add flags to the flags that are used to select meta-data Options to be saved in the info file of the session.

References Options::flags().

void delSaveFlags

(

int

flags

)

Delete the bits set in flags from the flags that are used to select meta-data Options to be saved in the info file of the session.

int dialog ( void  )

slot

Launches a dialog at stopTheSession(). It should return 1 to stop and safe the data, 0 to stop and discard the data, and -1 to continue the session. If -1000 is returned, then the dialog() functions should be called again at a later time, because the MetaData are currently locked.

References OptDialog::Accept, OptDialog::addButton(), OptDialog::addOptions(), OptWidget::BoldSectionsStyle, OptDialog::Defaults, MetaData::dialogClosed(), MetaData::dialogFlag(), OptDialog::exec(), OptDialog::NoAction, OptDialog::setCaption(), OptDialog::setRejectCode(), Options::setToDefaults(), and MetaData::unlock().

Referenced by Session::doStopTheSession().

void presetDialog ( void  )

slot

Launches a dialog from the menu. It is used to preset values of the dialog().

References OptDialog::Accept, OptDialog::addButton(), OptDialog::addOptions(), OptWidget::BoldSectionsStyle, OptDialog::Defaults, MetaData::dialogClosed(), MetaData::dialogFlag(), OptDialog::exec(), MetaData::presetDialogFlag(), OptDialog::setCaption(), OptDialog::setRejectCode(), Options::setToDefaults(), and MetaData::unlock().

Referenced by MetaData::addActions(), and MetaData::customEvent().

void dialogClosed ( int  r )

protectedslot

Informs MetaData that the dialog window is closed.

Referenced by MetaData::dialog(), and MetaData::presetDialog().

void customEvent ( QEvent *  qe )

protectedvirtual

References MetaData::presetDialog().

void setSectionName ( Options *  opt, const string &  name  )

protected

References Options::name(), Options::sectionsBegin(), Options::sectionsEnd(), and Options::setType().

Referenced by MetaData::saveXML().

---

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

• metadata.h
• metadata.cc