dxd - dynax driver framework  3211
cross platform open source driver development framework
dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream Struct Reference

stream interface descriptor More...

#include <dx_stream.h>

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

Classes

struct  config
 stream interface descriptor More...
 
struct  pin
 

Public Types

typedef struct pin pin_desc
 

Public Member Functions

unsigned int enumerate (dx_enum_prefix circular::format format) const
 enumerate typified pins More...
 
const struct pinfind (unsigned int &pin, dx_enum_prefix circular::format format=circular::format::any) const
 typified pin More...
 
 operator const target_t & () const
 

Public Attributes

struct dx::stream::desc::stream::config config [max_configurations]
 
unsigned int configurations
 number of configurations for this stream More...
 
struct dx::stream::desc::stream::pin pin [max_pins]
 
unsigned int pins
 
target_t target
 hardware interface More...
 
vendor_t vendor
 vendor specific config data More...
 

Detailed Description

template<typename target_t, int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
struct dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream

stream interface descriptor

Member Typedef Documentation

◆ pin_desc

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
typedef struct pin dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::pin_desc

Member Function Documentation

◆ enumerate()

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::enumerate ( dx_enum_prefix circular::format  format) const
inline

enumerate typified pins

Todo:
remove redundant pin_desc typedef once the llvm understands templates (coremidi)

◆ find()

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
const struct pin* dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::find ( unsigned int &  pin,
dx_enum_prefix circular::format  format = circular::format::any 
) const
inline

typified pin

◆ operator const target_t &()

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::operator const target_t & ( ) const
inline

Member Data Documentation

◆ config

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
struct dx::stream::desc::stream::config dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::config[max_configurations]

◆ configurations

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::configurations

number of configurations for this stream

◆ pin

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
struct dx::stream::desc::stream::pin dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::pin[max_pins]

◆ pins

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::pins

◆ target

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
target_t dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::target

hardware interface

◆ vendor

template<typename target_t , int max_clocks = 2, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
vendor_t dx::stream::desc< target_t, max_clocks, max_streams, max_configurations, max_pins, vendor_t >::stream::vendor

vendor specific config data

Todo:
evaluate if vendor data is part of the config

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

(c) copyright 2009 dynamic acoustics e.U. generated on Sat Aug 22 2020

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.