RTXI  3.0.0
The Real-Time eXperiment Interface Reference Manual
Data Structures | Public Member Functions
DataRecorder::Plugin Class Reference

#include <data_recorder.hpp>

Inheritance diagram for DataRecorder::Plugin:
Inheritance graph
Collaboration diagram for DataRecorder::Plugin:
Collaboration graph

Public Member Functions

 Plugin (const Plugin &)=delete
 
 Plugin (Plugin &&)=delete
 
Pluginoperator= (const Plugin &)=delete
 
Pluginoperator= (Plugin &&)=delete
 
 Plugin (Event::Manager *ev_manager)
 
 ~Plugin () override
 
void receiveEvent (Event::Object *event) override
 
void startRecording ()
 
void stopRecording ()
 
void openFile (const std::string &file_name)
 
void closeFile ()
 
void change_file (const std::string &file_name)
 
int create_component (IO::endpoint endpoint)
 
void destroy_component (IO::endpoint endpoint)
 
std::string getRecorderName (IO::endpoint endpoint)
 
DataRecorder::ComponentgetRecorderPtr (IO::endpoint endpoint)
 
RT::OS::FifogetFifo (IO::endpoint endpoint)
 
std::vector< record_channelget_recording_channels ()
 
int apply_tag (const std::string &tag)
 
void process_data_worker ()
 
std::string getOpenFilename () const
 
bool isFileOpen ()
 
bool isRecording ()
 
int getTrialCount () const
 
- Public Member Functions inherited from Widgets::Plugin
 Plugin (Event::Manager *ev_manager, std::string mod_name)
 
 Plugin (const Plugin &plugin)=delete
 
Pluginoperator= (const Plugin &plugin)=delete
 
 Plugin (Plugin &&)=delete
 
Pluginoperator= (Plugin &&)=delete
 
 ~Plugin () override
 
size_t getID ()
 
void attachComponent (std::unique_ptr< Widgets::Component > component)
 
void attachPanel (Widgets::Panel *panel)
 
int64_t getComponentIntParameter (const Variable::Id &parameter_id)
 
uint64_t getComponentUIntParameter (const Variable::Id &parameter_id)
 
double getComponentDoubleParameter (const Variable::Id &parameter_id)
 
template<typename T >
int setComponentParameter (const Variable::Id &parameter_id, T value)
 
std::string getName () const
 
bool getActive ()
 
int setActive (bool state)
 
std::string getLibrary () const
 
void setLibrary (const std::string &lib)
 
void registerComponent ()
 
void setComponentState (RT::State::state_t state)
 
virtual std::vector< Widgets::Variable::InfogetComponentParametersInfo ()
 
- Public Member Functions inherited from Event::Handler
 Handler ()=default
 
 Handler (const Handler &)=default
 
 Handler (Handler &&)=delete
 
Handleroperator= (const Handler &)=default
 
Handleroperator= (Handler &&)=delete
 
virtual ~Handler ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from Widgets::Plugin
Widgets::ComponentgetComponent ()
 
Event::ManagergetEventManager ()
 
QMainWindow * getQMainWindow ()
 
Widgets::PanelgetPanel ()
 

Detailed Description

Definition at line 162 of file data_recorder.hpp.

Constructor & Destructor Documentation

◆ Plugin() [1/3]

DataRecorder::Plugin::Plugin(const Plugin)
delete

◆ Plugin() [2/3]

DataRecorder::Plugin::Plugin(Plugin && )
delete

◆ Plugin() [3/3]

DataRecorder::Plugin::Plugin(Event::Managerev_manager)
explicit

Definition at line 498 of file data_recorder.cpp.

◆ ~Plugin()

DataRecorder::Plugin::~Plugin()
override

Definition at line 504 of file data_recorder.cpp.

Member Function Documentation

◆ apply_tag()

int DataRecorder::Plugin::apply_tag(const std::string & tag)

Definition at line 835 of file data_recorder.cpp.

◆ change_file()

void DataRecorder::Plugin::change_file(const std::string & file_name)

Definition at line 715 of file data_recorder.cpp.

◆ closeFile()

void DataRecorder::Plugin::closeFile()

Definition at line 699 of file data_recorder.cpp.

Here is the call graph for this function:

◆ create_component()

int DataRecorder::Plugin::create_component(IO::endpoint endpoint)

Definition at line 721 of file data_recorder.cpp.

Here is the call graph for this function:

◆ destroy_component()

void DataRecorder::Plugin::destroy_component(IO::endpoint endpoint)

Definition at line 774 of file data_recorder.cpp.

Here is the call graph for this function:

◆ get_recording_channels()

std::vector< DataRecorder::record_channel > DataRecorder::Plugin::get_recording_channels()

Definition at line 824 of file data_recorder.cpp.

◆ getFifo()

RT::OS::Fifo* DataRecorder::Plugin::getFifo(IO::endpoint endpoint)

◆ getOpenFilename()

std::string DataRecorder::Plugin::getOpenFilename()const
inline

Definition at line 186 of file data_recorder.hpp.

◆ getRecorderName()

std::string DataRecorder::Plugin::getRecorderName(IO::endpoint endpoint)

Definition at line 796 of file data_recorder.cpp.

◆ getRecorderPtr()

DataRecorder::Component * DataRecorder::Plugin::getRecorderPtr(IO::endpoint endpoint)

Definition at line 809 of file data_recorder.cpp.

◆ getTrialCount()

int DataRecorder::Plugin::getTrialCount()const
inline

Definition at line 189 of file data_recorder.hpp.

◆ isFileOpen()

bool DataRecorder::Plugin::isFileOpen()
inline

Definition at line 187 of file data_recorder.hpp.

◆ isRecording()

bool DataRecorder::Plugin::isRecording()
inline

Definition at line 188 of file data_recorder.hpp.

◆ openFile()

void DataRecorder::Plugin::openFile(const std::string & file_name)

Definition at line 668 of file data_recorder.cpp.

Here is the call graph for this function:

◆ operator=() [1/2]

Plugin& DataRecorder::Plugin::operator=(const Plugin)
delete

◆ operator=() [2/2]

Plugin& DataRecorder::Plugin::operator=(Plugin && )
delete

◆ process_data_worker()

void DataRecorder::Plugin::process_data_worker()

Definition at line 840 of file data_recorder.cpp.

◆ receiveEvent()

void DataRecorder::Plugin::receiveEvent(Event::Objectevent)
overridevirtual

Function called when a new event is fired

Parameters
eventpointer to Qt event object

Reimplemented from Widgets::Plugin.

Definition at line 518 of file data_recorder.cpp.

Here is the call graph for this function:

◆ startRecording()

void DataRecorder::Plugin::startRecording()

Definition at line 546 of file data_recorder.cpp.

◆ stopRecording()

void DataRecorder::Plugin::stopRecording()

Definition at line 564 of file data_recorder.cpp.


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