Pothos::WorkInfo Struct Reference

#include <WorkInfo.hpp>

Public Member Functions
	WorkInfo (void)
	Default constructor – zeros out members. More...

Public Attributes
std::vector< const void * >	inputPointers
std::vector< void * >	outputPointers
size_t	minElements
	The minimum number of elements of all indexed ports. More...
size_t	minInElements
	The minimum number of elements of input indexed ports. More...
size_t	minOutElements
	The minimum number of elements of output indexed ports. More...
size_t	minAllElements
	The minimum number of elements of all ports. More...
size_t	minAllInElements
	The minimum number of elements of input ports. More...
size_t	minAllOutElements
	The minimum number of elements of output ports. More...
long long	maxTimeoutNs

Detailed Description

Information about a work session. The worker can query this info from calls to work(). This information is not specific to a single port.

Constructor & Destructor Documentation

WorkInfo()

Pothos::WorkInfo::WorkInfo

(

void

)

Default constructor – zeros out members.

Member Data Documentation

inputPointers

std::vector<const void *> Pothos::WorkInfo::inputPointers

A vector of input pointers for indexable ports. inputPointers[i] == worker->input(i).buffer.as<const void>(); This is a convenience for APIs that use a vector of pointers.

maxTimeoutNs

long long Pothos::WorkInfo::maxTimeoutNs

The maximum time a call in work() is allowed to block. The maxTimeoutNs member is in units of nanoseconds. This is for workers that use blocking calls like select. Always use blocking calls with a timeout to be safe.

minAllElements

size_t Pothos::WorkInfo::minAllElements

The minimum number of elements of all ports.

minAllInElements

size_t Pothos::WorkInfo::minAllInElements

The minimum number of elements of input ports.

minAllOutElements

size_t Pothos::WorkInfo::minAllOutElements

The minimum number of elements of output ports.

minElements

size_t Pothos::WorkInfo::minElements

The minimum number of elements of all indexed ports.

minInElements

size_t Pothos::WorkInfo::minInElements

The minimum number of elements of input indexed ports.

minOutElements

size_t Pothos::WorkInfo::minOutElements

The minimum number of elements of output indexed ports.

outputPointers

std::vector<void *> Pothos::WorkInfo::outputPointers

A vector of output pointers for indexable ports. outputPointers[i] == worker->output(i).buffer.as<void>(); This is a convenience for APIs that use a vector of pointers.

---

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

• include/Pothos/Framework/WorkInfo.hpp