dxd - dynax driver framework 2.1.0d49
cross platform open source driver development framework
Loading...
Searching...
No Matches
dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config Struct Reference

stream interface descriptor More...

#include <dx_stream.h>

+ Collaboration diagram for dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config:

Classes

struct  clock
 
struct  dx_packed
 
struct  transaction
 

Public Member Functions

bool buffered () const
 
std::string describe () const
 describes config as channels* worldlength [buffered] granularity transactions size clock domain
 
uint32_t linesize () const
 total length of the samples of all channels
 
uint32_t size () const
 total transaction size
 

Public Attributes

uint32_t buffers
 optional: multiplier for stream buffers
 
uint32_t channels
 amount of channels in interface (forms the transaction::size together with wordlength and granularity)
 
struct dx::stream::desc::stream::config::clock clock
 
struct dx::stream::desc::stream::config::dx_packed options
 
struct dx::stream::desc::stream::config::transaction transaction
 
uint32_t wordlength
 total length of one sample/entity in the stream
 

Detailed Description

template<typename target_t, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
struct dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config

stream interface descriptor

A stream can have various configuration with varying supported samples rates, number of channels and data formats.

Todo
move target from stream to stream::config to relate USB alternate interface settings to the configuration

Member Function Documentation

◆ buffered()

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::buffered ( ) const
inline
+ Here is the caller graph for this function:

◆ describe()

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
std::string dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::describe ( ) const
inline

describes config as channels* worldlength [buffered] granularity transactions size clock domain

+ Here is the call graph for this function:

◆ linesize()

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::linesize ( ) const
inline

total length of the samples of all channels

◆ size()

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::size ( ) const
inline

total transaction size

Member Data Documentation

◆ buffers

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::buffers

optional: multiplier for stream buffers

◆ channels

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::channels

amount of channels in interface (forms the transaction::size together with wordlength and granularity)

◆ clock

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
struct dx::stream::desc::stream::config::clock dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::clock

◆ options

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
struct dx::stream::desc::stream::config::dx_packed dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::options

◆ transaction

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
struct dx::stream::desc::stream::config::transaction dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::transaction

◆ wordlength

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream::config::wordlength

total length of one sample/entity in the stream


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

(c) copyright 2009 dynamic acoustics e.U. generated on Sat Mar 2 2024

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.