pulp::host::SampleKernelDescriptor Struct Reference

#include <custom_node_type.hpp>

Public Member Functions
bool	is_valid_registration () const noexcept

Public Attributes
std::uint32_t	abi_version = kAbiVersion
std::string	type_id
int	version = 1
std::uint32_t	num_input_ports = 0
std::uint32_t	num_output_ports = 0
SampleKernelCausality	causality = SampleKernelCausality::Combinational
SampleKernelScope	scope = SampleKernelScope::RegionOnly
SampleKernelConfigKind	authored_config_kind = SampleKernelConfigKind::Invalid
std::uint32_t	state_size = 0
std::uint32_t	state_alignment = 1
SampleKernelConstructFn	construct = nullptr
SampleKernelResetFn	reset = nullptr
SampleKernelDestroyFn	destroy = nullptr
SampleKernelProcessFn	process = nullptr
SampleDelayPublishFn	delay_publish = nullptr
SampleDelayCommitFn	delay_commit = nullptr
std::uint32_t	latency_samples = 0
SampleKernelMetadata	metadata

Static Public Attributes
static constexpr std::uint32_t	kAbiVersion = 1

Member Function Documentation

is_valid_registration()

bool pulp::host::SampleKernelDescriptor::is_valid_registration ( ) const

noexcept

Member Data Documentation

abi_version

std::uint32_t pulp::host::SampleKernelDescriptor::abi_version = kAbiVersion

authored_config_kind

SampleKernelConfigKind pulp::host::SampleKernelDescriptor::authored_config_kind = SampleKernelConfigKind::Invalid

causality

SampleKernelCausality pulp::host::SampleKernelDescriptor::causality = SampleKernelCausality::Combinational

construct

SampleKernelConstructFn pulp::host::SampleKernelDescriptor::construct = nullptr

delay_commit

SampleDelayCommitFn pulp::host::SampleKernelDescriptor::delay_commit = nullptr

delay_publish

SampleDelayPublishFn pulp::host::SampleKernelDescriptor::delay_publish = nullptr

destroy

SampleKernelDestroyFn pulp::host::SampleKernelDescriptor::destroy = nullptr

kAbiVersion

std::uint32_t pulp::host::SampleKernelDescriptor::kAbiVersion = 1

staticconstexpr

latency_samples

std::uint32_t pulp::host::SampleKernelDescriptor::latency_samples = 0

metadata

SampleKernelMetadata pulp::host::SampleKernelDescriptor::metadata

num_input_ports

std::uint32_t pulp::host::SampleKernelDescriptor::num_input_ports = 0

num_output_ports

std::uint32_t pulp::host::SampleKernelDescriptor::num_output_ports = 0

process

SampleKernelProcessFn pulp::host::SampleKernelDescriptor::process = nullptr

reset

SampleKernelResetFn pulp::host::SampleKernelDescriptor::reset = nullptr

scope

SampleKernelScope pulp::host::SampleKernelDescriptor::scope = SampleKernelScope::RegionOnly

state_alignment

std::uint32_t pulp::host::SampleKernelDescriptor::state_alignment = 1

state_size

std::uint32_t pulp::host::SampleKernelDescriptor::state_size = 0

type_id

std::string pulp::host::SampleKernelDescriptor::type_id

version

int pulp::host::SampleKernelDescriptor::version = 1

---

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

• /home/runner/work/pulp/pulp/core/host/include/pulp/host/custom_node_type.hpp