Classes | Public Member Functions | Private Attributes | Friends | List of all members
Xs4FileTask Class Reference

A class for handling file loading process in a separate thread. More...

Inheritance diagram for Xs4FileTask:
Inheritance graph
[legend]

Classes

class  ReaderThread
 

Public Member Functions

bool exec () override
 Check if the file load is complete. More...
 
 Xs4FileTask (FileLoader *inf, XsDevice *device)
 Construct a file task, but does not schedule it. More...
 
virtual ~Xs4FileTask ()
 Destroy this process task. More...
 
- Public Member Functions inherited from xsens::ThreadPoolTask
bool isCanceling () const
 Returns true if the task has been told to cancel itself. More...
 
virtual unsigned int needToWaitFor ()
 This function gets called by PooledThread when the exec() function returns false to determine if we should wait for a specific task. More...
 
unsigned int taskId () const
 Returns the task ID of the task or 0 if it doesn't have a proper ID (yet) More...
 
 ThreadPoolTask ()
 
virtual ~ThreadPoolTask ()
 

Private Attributes

XsDevicem_device
 
FileLoaderm_loader
 The Communicator object that contains information on calibration and filtering. More...
 
Xs4FileTask::ReaderThread m_thread
 

Friends

class ReaderThread
 

Detailed Description

A class for handling file loading process in a separate thread.

This task will delegate the loading of the file to yet another thread, keeping the task in the threadpool as a monitoring task. This is because ThreadPoolTask tasks should be small tasks and file loading can take a while.

Definition at line 328 of file mtbfilecommunicator.cpp.

Constructor & Destructor Documentation

◆ Xs4FileTask()

Xs4FileTask::Xs4FileTask ( FileLoader inf,
XsDevice device 
)
inline

Construct a file task, but does not schedule it.

Definition at line 333 of file mtbfilecommunicator.cpp.

◆ ~Xs4FileTask()

virtual Xs4FileTask::~Xs4FileTask ( )
inlinevirtual

Destroy this process task.

Definition at line 364 of file mtbfilecommunicator.cpp.

Member Function Documentation

◆ exec()

bool Xs4FileTask::exec ( )
inlineoverridevirtual

Check if the file load is complete.

Implements xsens::ThreadPoolTask.

Definition at line 345 of file mtbfilecommunicator.cpp.

Friends And Related Function Documentation

◆ ReaderThread

friend class ReaderThread
friend

Definition at line 383 of file mtbfilecommunicator.cpp.

Member Data Documentation

◆ m_device

XsDevice* Xs4FileTask::m_device
private

Definition at line 372 of file mtbfilecommunicator.cpp.

◆ m_loader

FileLoader* Xs4FileTask::m_loader
private

The Communicator object that contains information on calibration and filtering.

Definition at line 371 of file mtbfilecommunicator.cpp.

◆ m_thread

Xs4FileTask::ReaderThread Xs4FileTask::m_thread
private

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


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:22