v2.0.0
Loading...
Searching...
No Matches
fiff_types.h File Reference

Primitive scalar typedefs and forward-compatible aliases backing the FIFF type system. More...

#include "fiff_constants.h"
#include "fiff_time.h"
#include "fiff_data_ref.h"
#include <Eigen/Core>
#include <QList>
#include <QStringList>
#include <QPair>
#include <QVariant>
Include dependency graph for fiff_types.h:

Go to the source code of this file.

Namespaces

namespace  FIFFLIB
 FIFF file I/O, in-memory data structures and high-level readers/writers.

Macros

#define FIFFM_CHPOS(x)

Typedefs

typedef Eigen::Matrix< qint16, Eigen::Dynamic, Eigen::Dynamic > FIFFLIB::MatrixDau16
typedef Eigen::Matrix< short, Eigen::Dynamic, Eigen::Dynamic > FIFFLIB::MatrixShort
typedef unsigned char FIFFLIB::fiff_byte_t
typedef char FIFFLIB::fiff_char_t
typedef qint16 FIFFLIB::fiff_short_t
typedef quint16 FIFFLIB::fiff_ushort_t
typedef qint32 FIFFLIB::fiff_int_t
typedef quint32 FIFFLIB::fiff_uint_t
typedef qint64 FIFFLIB::fiff_long_t
typedef quint64 FIFFLIB::fiff_ulong_t
typedef float FIFFLIB::fiff_float_t
typedef double FIFFLIB::fiff_double_t
typedef quint16 FIFFLIB::fiff_dau_pack13_t
typedef quint16 FIFFLIB::fiff_dau_pack14_t
typedef qint16 FIFFLIB::fiff_dau_pack16_t
typedef qint32 FIFFLIB::fiff_julian_t
typedef char FIFFLIB::fiff_data_t
typedef FiffId FIFFLIB::fiffIdRec
 Backward-compatible typedef for the old fiffIdRec struct.
typedef FiffId FIFFLIB::fiff_id_t
 Backward-compatible typedef for the old fiff_id_t.
typedef FiffId * FIFFLIB::fiffId
 Backward-compatible pointer typedef for the old fiffId pointer.
typedef FiffDirEntry FIFFLIB::fiffDirEntryRec
 Backward-compatible typedef for the old fiffDirEntryRec struct.
typedef FiffDirEntry FIFFLIB::fiff_dir_entry_t
 Backward-compatible typedef for the old fiff_dir_entry_t.
typedef FiffDirEntry * FIFFLIB::fiffDirEntry
 Backward-compatible pointer typedef for the old fiffDirEntry pointer.
typedef FiffDigPoint FIFFLIB::fiffDigPointRec
 Backward-compatible typedef for the old fiffDigPointRec struct.

Detailed Description

Primitive scalar typedefs and forward-compatible aliases backing the FIFF type system.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2012-2026 MNE-CPP Authors

Author
Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org; Lorenz Esch loren.nosp@m.z.es.nosp@m.ch@tu.nosp@m.-ilm.nosp@m.enau..nosp@m.de; Juan GPC jgarc.nosp@m.iapr.nosp@m.ieto@.nosp@m.mgh..nosp@m.harva.nosp@m.rd.e.nosp@m.du; Gabriel Motta gabri.nosp@m.elbe.nosp@m.nmott.nosp@m.a@gm.nosp@m.ail.c.nosp@m.om
Since
0.1.0
Date
August 2012

Defines the fixed-width FIFFLIB primitives (fiff_int_t, fiff_float_t, fiff_byte_t, fiff_double_t, the DAU packed half-precision integer aliases, the Julian-day type, etc.) so that on-disk records preserve the exact byte layout documented by the FIFF specification regardless of host platform. It also publishes a handful of Eigen typedefs (MatrixDau16, MatrixShort) used by the matrix tag readers in FIFFLIB::FiffStream and a small set of empty-default sentinel objects (defaultMatrixXd, defaultQStringList, ...) that let callers express "no value provided" on optional arguments without relying on std::optional, matching the historical MATLAB-style signatures inherited from the MNE matlab toolbox.

Note: the leftover "Old fiff_type declarations - replace them" heading on the previous header line reflects an in-progress cleanup toward strongly typed C++ replacements; new code should prefer the class wrappers (FIFFLIB::FiffId, FIFFLIB::FiffChInfo, ...) over the legacy "Rec" struct aliases re-exported for backwards compatibility.

Definition in file fiff_types.h.

Macro Definition Documentation

◆ FIFFM_CHPOS

#define FIFFM_CHPOS ( x)
Value:
&((x)->chpos)

Definition at line 153 of file fiff_types.h.