dxd - dynax driver framework  2675
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dx::stream::desc< target_t, 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_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 (enum class pin::format format) const
 enumerate typified pins More...
 
const struct pinfind (unsigned int &pin, enum class pin::format format=pin::format::any) const
 typified pin More...
 
 operator const target_t & () const
 

Public Attributes

struct {
   unsigned int   domain
 identify the clock domain to which this stream belongs, More...
 
clock
 
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
 make sure all streams that are controlled by the same clock have the same clock domain #. More...
 

Detailed Description

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

stream interface descriptor

Member Typedef Documentation

template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::pin_desc

Member Function Documentation

template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::enumerate ( enum class pin::format  format) const
inline

enumerate typified pins

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

+ Here is the caller graph for this function:

template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::find ( unsigned int &  pin,
enum class pin::format  format = pin::format::any 
) const
inline

typified pin

+ Here is the caller graph for this function:

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

Member Data Documentation

struct { ... } dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::clock
template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::config[max_configurations]
template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::configurations

number of configurations for this stream

template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::domain

identify the clock domain to which this stream belongs,

template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::pin[max_pins]
template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::pins
template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::target

hardware interface

template<typename target_t, 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_streams, max_configurations, max_pins, vendor_t >::stream::vendor

make sure all streams that are controlled by the same clock have the same clock domain #.

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 Tue Dec 4 2018

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.