FIFFLIB::FiffDirEntry Class Reference

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

#include <fiff_dir_entry.h>

Public Types
using	SPtr = QSharedPointer<FiffDirEntry>
using	ConstSPtr = QSharedPointer<const FiffDirEntry>
using	UPtr = std::unique_ptr<FiffDirEntry>
using	ConstUPtr = std::unique_ptr<const FiffDirEntry>

Public Member Functions
	FiffDirEntry ()
	FiffDirEntry (const FiffDirEntry &p_FiffDirEntry)
	~FiffDirEntry ()

Static Public Member Functions
static qint32	storageSize ()

Public Attributes
fiff_int_t	kind
fiff_int_t	type
fiff_int_t	size
fiff_int_t	pos

Detailed Description

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

Exact memory image of the legacy fiffDirEntryRec: kind (32-bit), type (32-bit), size (32-bit), pos (32-bit). The arrays of these records materialize the FIFF_DIR tag at the tail of every well-formed FIFF file and drive random-access tag lookup in FiffStream.

Definition at line 63 of file fiff_dir_entry.h.

Member Typedef Documentation

ConstSPtr

using FIFFLIB::FiffDirEntry::ConstSPtr = QSharedPointer<const FiffDirEntry>

Const shared pointer type for FiffDirEntry.

Definition at line 67 of file fiff_dir_entry.h.

ConstUPtr

using FIFFLIB::FiffDirEntry::ConstUPtr = std::unique_ptr<const FiffDirEntry>

Const unique pointer type for FiffDirEntry.

Definition at line 69 of file fiff_dir_entry.h.

SPtr

using FIFFLIB::FiffDirEntry::SPtr = QSharedPointer<FiffDirEntry>

Shared pointer type for FiffDirEntry.

Definition at line 66 of file fiff_dir_entry.h.

UPtr

using FIFFLIB::FiffDirEntry::UPtr = std::unique_ptr<FiffDirEntry>

Unique pointer type for FiffDirEntry.

Definition at line 68 of file fiff_dir_entry.h.

Constructor & Destructor Documentation

FiffDirEntry() [1/2]

FiffDirEntry::FiffDirEntry

(

)

Constructs the dir entry.

Definition at line 35 of file fiff_dir_entry.cpp.

FiffDirEntry() [2/2]

FiffDirEntry::FiffDirEntry

(

const FiffDirEntry &

p_FiffDirEntry

)

Copy constructor.

Parameters

[in]

p_FiffDirEntry

Dir Entry which should be copied.

Definition at line 45 of file fiff_dir_entry.cpp.

~FiffDirEntry()

FiffDirEntry::~FiffDirEntry

(

)

Destroys the dir entry.

Definition at line 55 of file fiff_dir_entry.cpp.

Member Function Documentation

storageSize()

qint32 FIFFLIB::FiffDirEntry::storageSize ( )

inlinestatic

Size of the old struct (fiffDirEntryRec) 4*int = 4*4 = 16

Returns

the size of the old struct fiffDirEntryRec.

Definition at line 111 of file fiff_dir_entry.h.

Member Data Documentation

kind

fiff_int_t FIFFLIB::FiffDirEntry::kind

Tag number.

Definition at line 100 of file fiff_dir_entry.h.

pos

fiff_int_t FIFFLIB::FiffDirEntry::pos

Location in file; Note: the data is located at pos + FIFFC_DATA_OFFSET: 2GB restriction -> change this to fiff_long_t.

Definition at line 103 of file fiff_dir_entry.h.

size

fiff_int_t FIFFLIB::FiffDirEntry::size

How many bytes.

Definition at line 102 of file fiff_dir_entry.h.

type

fiff_int_t FIFFLIB::FiffDirEntry::type

Data type.

Definition at line 101 of file fiff_dir_entry.h.

---

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

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