PCIeSinkOptions Struct

Construction options for a PCIeSink Node. More...

Declaration

struct simaai::neat::PCIeSinkOptions { ... }

Included Headers

#include <PCIeSink.h>

Public Member Attributes Index

std::string	config_file
	Optional simaaipciesink config file path. More...
std::string	data_buf_name = "overlay"
	Name of the host-side buffer that receives data. More...
int	data_buffer_size = 4194304
	Data buffer size in bytes (default 4 MiB). More...
int	num_buffers = 5
	Number of buffers in the pool. More...
int	queue = 0
	Queue depth for outgoing samples. More...
std::string	param_buf_name = ...
	Auxiliary parameter buffer name (multi-buffer mode). More...
int	param_buffer_size = 48
	Parameter buffer size in bytes (multi-buffer mode). More...
bool	use_multi_buffers = false
	Enable the multi-buffer (data + params) protocol. More...
bool	sync = true
	Sync to pipeline clock when delivering buffers. More...
bool	async_state = true
	Allow async state changes on this sink. More...
int64_t	max_lateness_ns = -1
	Max lateness in ns; -1 = unlimited (no late-frame drop). More...
uint64_t	processing_deadline_ns = 20000000
	Processing deadline in ns (default 20 ms). More...
bool	transmit_kpi = false
	If true, transmit KPI/diagnostic packets alongside data. More...
bool	qos = false
	Enable QoS reporting on this sink. More...

Description

Construction options for a PCIeSink Node.

Definition at line 26 of file PCIeSink.h.

Public Member Attributes

async_state

bool simaai::neat::PCIeSinkOptions::async_state = true

Allow async state changes on this sink.

Definition at line 42 of file PCIeSink.h.

42 bool async_state = true;

config_file

std::string simaai::neat::PCIeSinkOptions::config_file

Optional simaaipciesink config file path.

Definition at line 28 of file PCIeSink.h.

28 std::string config_file;

data_buf_name

std::string simaai::neat::PCIeSinkOptions::data_buf_name = "overlay"

Name of the host-side buffer that receives data.

Definition at line 29 of file PCIeSink.h.

29 std::string data_buf_name = "overlay";

data_buffer_size

int simaai::neat::PCIeSinkOptions::data_buffer_size = 4194304

Data buffer size in bytes (default 4 MiB).

Definition at line 30 of file PCIeSink.h.

30 int data_buffer_size = 4194304;

max_lateness_ns

int64_t simaai::neat::PCIeSinkOptions::max_lateness_ns = -1

Max lateness in ns; -1 = unlimited (no late-frame drop).

Definition at line 43 of file PCIeSink.h.

43 int64_t max_lateness_ns = -1;

num_buffers

int simaai::neat::PCIeSinkOptions::num_buffers = 5

Number of buffers in the pool.

Definition at line 31 of file PCIeSink.h.

31 int num_buffers = 5;

param_buf_name

std::string simaai::neat::PCIeSinkOptions::param_buf_name

Auxiliary parameter buffer name (multi-buffer mode).

Initialiser

= "camera_params"

Definition at line 35 of file PCIeSink.h.

35 std::string param_buf_name =

param_buffer_size

int simaai::neat::PCIeSinkOptions::param_buffer_size = 48

Parameter buffer size in bytes (multi-buffer mode).

Definition at line 37 of file PCIeSink.h.

37 int param_buffer_size = 48;

processing_deadline_ns

uint64_t simaai::neat::PCIeSinkOptions::processing_deadline_ns = 20000000

Processing deadline in ns (default 20 ms).

Definition at line 44 of file PCIeSink.h.

44 uint64_t processing_deadline_ns = 20000000;

qos

bool simaai::neat::PCIeSinkOptions::qos = false

Enable QoS reporting on this sink.

Definition at line 48 of file PCIeSink.h.

48 bool qos = false;

queue

int simaai::neat::PCIeSinkOptions::queue = 0

Queue depth for outgoing samples.

Definition at line 32 of file PCIeSink.h.

32 int queue = 0;

sync

bool simaai::neat::PCIeSinkOptions::sync = true

Sync to pipeline clock when delivering buffers.

Definition at line 41 of file PCIeSink.h.

41 bool sync = true;

transmit_kpi

bool simaai::neat::PCIeSinkOptions::transmit_kpi = false

If true, transmit KPI/diagnostic packets alongside data.

Definition at line 47 of file PCIeSink.h.

47 bool transmit_kpi = false;

use_multi_buffers

bool simaai::neat::PCIeSinkOptions::use_multi_buffers = false

Enable the multi-buffer (data + params) protocol.

Definition at line 38 of file PCIeSink.h.

38 bool use_multi_buffers = false;

---

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

• PCIeSink.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.