tobicore  7.0.0
 All Classes Functions Variables Typedefs Enumerator Friends Groups Pages
TCBlock Class Reference

Data block. More...

#include <tobicore/TCBlock.hpp>

+ Inheritance diagram for TCBlock:
+ Collaboration diagram for TCBlock:

Public Member Functions

 TCBlock (void)
 Constructor.
virtual int SetBlockIdx (int fidx=TCBlock::BlockIdxUnset)
 Frame index setter.
virtual int GetBlockIdx (void) const
 Frame index getter.
virtual int IncBlockIdx (void)
 Increments frame index.
virtual void UnsetBlockIdx (void)
 Unsets (invalidates) frame index.
virtual bool IsSetBlockIdx (void) const
 Checks if frame index is set (valid)

Public Attributes

TCTimestamp absolute
 Absolute timestamp.
TCTimestamp relative
 Relative timestamp.

Static Public Attributes

static const int BlockIdxUnset = -1
 Unset frame index value.

Protected Attributes

int _blockidx
 Frame index.

Detailed Description

Data block.

Each communication blocks in the BCI should carry a frame index value (generally set by the acquisition module), an absolute timestamp (i.e. 2011-11-19, 22:00:00.00.00) and a relative timestamp (i.e. 200 seconds).

Examples:
tcblock.cpp.

Definition at line 35 of file TCBlock.hpp.

Member Function Documentation

bool TCBlock::IsSetBlockIdx ( void  ) const
virtual

Checks if frame index is set (valid)

Returns
True if set, false otherwise

Definition at line 45 of file TCBlock.cpp.

+ Here is the caller graph for this function:

void TCBlock::UnsetBlockIdx ( void  )
virtual

Unsets (invalidates) frame index.

If the frame index is unset, it means a particular communication blocks has not been generated within the BCI pipeline. For example, a BCI-controlled robot on the moon will send messages without setting the frame index. A neurofeedback will receive and generate communication blocks that carry both a correct frame index and all the timestamp information.

Definition at line 41 of file TCBlock.cpp.


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