FIFFLIB::FiffExplain Class Reference

Names of FIFF tag kinds, block kinds, units, unit multipliers and channel kinds. More...

#include <fiff_explain.h>

Static Public Member Functions
static QString	tag (int kind)
static QString	block (int kind)
static QString	unit (int unit)
static QString	unitMultiplier (int unitMul)
static QString	channelKind (int kind)

Detailed Description

Names of FIFF tag kinds, block kinds, units, unit multipliers and channel kinds.

Every lookup returns an empty string for a value the table does not know.

Definition at line 46 of file fiff_explain.h.

Member Function Documentation

block()

QString FiffExplain::block ( int kind )

static

Name of a block kind (FIFFB_*), e.g. "meas. info" for FIFFB_MEAS_INFO.

Parameters

[in]

kind

Block kind.

Returns

The name, or an empty string.

Definition at line 101 of file fiff_explain.cpp.

channelKind()

QString FiffExplain::channelKind ( int kind )

static

Name of a channel kind (FIFFV_*_CH), e.g. "EEG" for FIFFV_EEG_CH.

Parameters

[in]

kind

Channel kind.

Returns

The name, or an empty string.

Definition at line 122 of file fiff_explain.cpp.

tag()

QString FiffExplain::tag ( int kind )

static

Name of a tag kind (FIFF_*), e.g. "channel" for FIFF_CH_INFO.

Parameters

[in]

kind

Tag kind.

Returns

The name, or an empty string.

Definition at line 94 of file fiff_explain.cpp.

unit()

QString FiffExplain::unit ( int unit )

static

SI symbol of a unit (FIFF_UNIT_*), e.g. "T/m" for FIFF_UNIT_T_M; FIFF_UNIT_NONE has an empty symbol.

Parameters

[in]

unit

Unit.

Returns

The symbol, or an empty string.

Definition at line 108 of file fiff_explain.cpp.

unitMultiplier()

QString FiffExplain::unitMultiplier ( int unitMul )

static

SI prefix of a unit multiplier (FIFF_UNITM_*), e.g. "f" for FIFF_UNITM_F.

Parameters

[in]

unitMul

Unit multiplier.

Returns

The prefix, or an empty string.

Definition at line 115 of file fiff_explain.cpp.

---

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

• src/libraries/fiff/fiff_explain.h
• src/libraries/fiff/fiff_explain.cpp