from::param::param_file Struct Reference

The layout of a .param file. More...

#include <param_file.hpp>

Classes
struct	param_row_locator
	An instance of a structure describing a param table entry later in the file. More...

Public Member Functions
uintptr_t	get_file_start () const noexcept
	Get the file start as an integer pointer representation.
char *	get_param_type () const noexcept
	Get a pointer to the null terminated param type char string.
std::span< param_row_locator >	get_param_row_locators () const noexcept
	Get the param row locators in this param file.

Public Attributes
uint32_t	_end
	The "end" offset, does not always point to valid data.
uint16_t	data_offset
	The short data offset (always 0), purpose is unclear.
uint16_t	paramdef_version
	The paramdef version.
uint16_t	row_count
	How many rows there are in the param table.
uint64_t	param_type_offset
	Offset of the param type string.
uint64_t	param_data_offset
	The offset of the raw param data.

Detailed Description

The layout of a .param file.

.param files contain whole param tables of a given param type.

Member Function Documentation

get_file_start()

uintptr_t from::param::param_file::get_file_start ( ) const

inlinenoexcept

Get the file start as an integer pointer representation.

Returns

uintptr_t the file start pointer

get_param_row_locators()

std::span< param_row_locator > from::param::param_file::get_param_row_locators ( ) const

inlinenoexcept

Get the param row locators in this param file.

Returns

std::span<param_row_locator> a span of all the locators

get_param_type()

char * from::param::param_file::get_param_type ( ) const

inlinenoexcept

Get a pointer to the null terminated param type char string.

Returns

char* null terminated char param type string

Member Data Documentation

_end

uint32_t from::param::param_file::_end

The "end" offset, does not always point to valid data.

Most often points to the last 16 bytes of the file.

param_type_offset

uint64_t from::param::param_file::param_type_offset

Offset of the param type string.

The type string is a null terminated char string containing the paramdef/param type name.

row_count

uint16_t from::param::param_file::row_count

How many rows there are in the param table.

Note it is a 16-bit unsigned integer, therefore only 65535 rows may be defined in a single param file at once.

---

The documentation for this struct was generated from the following file:

• include/param/param_file.hpp