fiff_dir_entry.h File Reference

Single entry of the FIFF tag directory: kind, type, byte size and absolute file position. More...

#include "fiff_global.h"
#include "fiff_types.h"
#include <QSharedPointer>
#include <memory>

Include dependency graph for fiff_dir_entry.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	FIFFLIB::FiffDirEntry
	Directory entry: tag kind + on-disk type + byte size + absolute file offset (16-byte record). More...

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

Detailed Description

Single entry of the FIFF tag directory: kind, type, byte size and absolute file position.

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; Christof Pieloth pielo.nosp@m.th@l.nosp@m.abp.h.nosp@m.twk-.nosp@m.leipz.nosp@m.ig.d.nosp@m.e; 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

September 2012

After the last tag of a FIFF file the writer appends a FIFF_DIR tag whose payload is an array of fiffDirEntryRec records, one per tag in the stream, terminated by a sentinel with kind = -1. The directory turns linear FIFF I/O into random-access: FiffStream consults it to locate any tag by kind without rescanning the file, and FiffDirNode uses it to materialize the block hierarchy (FIFFB_BLOCK_START / FIFFB_BLOCK_END pairs) into a navigable tree.

FiffDirEntry is the in-memory mirror of that 16-byte record. It is intentionally trivially copyable so the directory can be slurped in as a single Eigen / Qt vector.

Definition in file fiff_dir_entry.h.