PlotSink Class Reference

Text output sink Output input data at each tick to sequence numbered text files, to Marsyas messages (default = stdout), and as a MATLAB plot if MATLAB engine is being used. More...

#include <PlotSink.h>

Inherits MarSystem.

Public Member Functions
MarSystem *	clone () const
void	myProcess (realvec &in, realvec &out)
	Processes data.
void	myUpdate (MarControlPtr sender)
	Updates internal state due to a control change.
	PlotSink (std::string name)
	PlotSink (const PlotSink &a)
	~PlotSink ()

---

Detailed Description

Text output sink Output input data at each tick to sequence numbered text files, to Marsyas messages (default = stdout), and as a MATLAB plot if MATLAB engine is being used.

Controls:

• mrs_bool/sequence [w] : when true, this control activates the writing of sequence numbered files containing the input data at each tick.
• mrs_bool/single_file [w] : when true, data is written to a single file in addition to multiple numbered files (if mrs_bool/sequence is true).
• mrs_bool/no_ticks [w] : when this and single_file are true, data is written to a single file with no line breaks between ticks.
• mrs_string/filename [w] : base filename used for the output sequence numbered files.

• mrs_bool/messages [w] : when true, activates the writing of the input data using Marsyas messages (i.e. MRSMSG() - - by default messages are sent to the stdout)
• mrs_string/separator [w] : separator character/string used when outputting input data using Marsyas messages (i.e. MRSMSG() - by default messages are sent to the stdout).

• mrs_bool/matlab [w]: when true, input data is sent to MATLAB using MATLAB engine calls (if enabled), to a MATLAB variable of the form "type_name_indata".
• mrs_string/matlabCommand [w] : MATLAB command to be evaluated at each process tick (after sending input data to MATLAB). By default it is set to "plot(type_name_indata);".

Definition at line 55 of file PlotSink.h.

---

Constructor & Destructor Documentation

PlotSink

(

std::string

name

)

Definition at line 34 of file PlotSink.cpp.

PlotSink

(

const PlotSink &

a

)

Definition at line 41 of file PlotSink.cpp.

~PlotSink

(

)

Definition at line 55 of file PlotSink.cpp.

---

Member Function Documentation

MarSystem * clone

(

)

const [virtual]

Implements MarSystem.

Definition at line 65 of file PlotSink.cpp.

void myProcess	(	realvec &	in,
		realvec &	out
	)		[virtual]

Processes data.

Parameters:

in	Input data to read.
out	Output data to write.

Implement this method in subclass to define specific data processing.

Implements MarSystem.

Definition at line 109 of file PlotSink.cpp.

void myUpdate

(

MarControlPtr

sender

)

[virtual]

Updates internal state due to a control change.

Parameters:

sender

The control that triggered the update; more precisely, any control passed to the update() method - could be an invalid one.

Implement this method in subclass to define specific response to control changes.

Reimplemented from MarSystem.

Definition at line 87 of file PlotSink.cpp.

---

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

• /usr/src/RPM/BUILD/marsyas-0.6.0/src/marsyas/marsystems/PlotSink.h
• /usr/src/RPM/BUILD/marsyas-0.6.0/src/marsyas/marsystems/PlotSink.cpp