dxd - dynax driver framework 2.2.0d81
cross platform open source driver development framework
Loading...
Searching...
No Matches
dx::stream::pin< _desc_t, _circular_t, _device_t > Class Template Referenceabstract

#include <dx_stream_pin.h>

+ Inheritance diagram for dx::stream::pin< _desc_t, _circular_t, _device_t >:
+ Collaboration diagram for dx::stream::pin< _desc_t, _circular_t, _device_t >:

Public Types

typedef _circular_t circular_t
 
typedef _desc_t desc_t
 
typedef _device_t device_t
 

Public Member Functions

template<unsigned int channels, typename channel_t >
pinattach (channel_t **io[2], uint64_t channel_map[(channels+63)/64]) try
 
virtual void conclude () noexcept
 conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
 
 dx_catchall_rethrow () virtual bool encoder(dx
 
 dx_catchall_rethrow () virtual pin &abort()
 
 dx_catchall_rethrow () virtual pin &clear()
 
 dx_catchall_rethrow () virtual pin &flush() noexcept
 
 dx_catchall_rethrow () virtual pin &reset()
 
 dx_catchall_rethrow () virtual pin &signal()
 
 dx_catchall_rethrow () virtual pin &wait()
 
 dx_catchall_rethrow () virtual uint32_t samplerate() const
 
 dx_catchall_rethrow () virtual uint32_t samplerate(uint32_t samplerate)
 
 dx_catchall_rethrow () virtual void start(uint64_t frame=0) try
 
virtual float encoder (dx::stream::encoder::index::type type, int index) const
 
virtual void info (std::ostream &os)
 log object class information
 
virtual pininitialize ()
 
virtual void launch ()
 launch notification: object mounted and ready to use
 
virtual operator circular_t * () const noexcept
 
virtual circular_toperator-> () const noexcept
 
 pin (device_t &device, const typename desc_t::stream::desc &stream_desc, const typename desc_t::stream::pin::desc &pin_desc)
 
virtual void stop (bool force=false) noexcept
 
 ~pin () noexcept override
 

Public Attributes

dx::stream::channel::controlcontrol = nullptr
 
bool launched {}
 
stream_t & stream
 

Member Typedef Documentation

◆ circular_t

template<typename _desc_t , typename _circular_t , typename _device_t >
typedef _circular_t dx::stream::pin< _desc_t, _circular_t, _device_t >::circular_t

◆ desc_t

template<typename _desc_t , typename _circular_t , typename _device_t >
typedef _desc_t dx::stream::pin< _desc_t, _circular_t, _device_t >::desc_t

◆ device_t

template<typename _desc_t , typename _circular_t , typename _device_t >
typedef _device_t dx::stream::pin< _desc_t, _circular_t, _device_t >::device_t

Constructor & Destructor Documentation

◆ pin()

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::pin ( device_t & device,
const typename desc_t::stream::desc & stream_desc,
const typename desc_t::stream::pin< _desc_t, _circular_t, _device_t >::desc & pin_desc )
inline
Todo
pin::control: find descriptive, scoping name; evaluate presence in non-kernel interface

◆ ~pin()

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::~pin ( )
inlineoverridenoexcept

Member Function Documentation

◆ attach()

template<typename _desc_t , typename _circular_t , typename _device_t >
template<unsigned int channels, typename channel_t >
pin & dx::stream::pin< _desc_t, _circular_t, _device_t >::attach ( channel_t ** io[2],
uint64_t channel_map[(channels+63)/64] )
inline

◆ conclude()

virtual void dx::object::conclude ( )
inlinevirtualnoexceptinherited

conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.

Reimplemented in dx::proxy::device, dx::proxy::device, dx::map::driver< device >, and dx::map::driver< device_t >.

+ Here is the caller graph for this function:

◆ dx_catchall_rethrow() [1/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( )
inline

◆ dx_catchall_rethrow() [2/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [3/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [4/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &
inlinenoexcept

◆ dx_catchall_rethrow() [5/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [6/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [7/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [8/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) const
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [9/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( )
inline
+ Here is the call graph for this function:

◆ dx_catchall_rethrow() [10/10]

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( )
inlinepure virtual

Implemented in dx::proxy::stream::pin< desc_t, circular_t, device_t >.

+ Here is the call graph for this function:

◆ encoder()

template<typename _desc_t , typename _circular_t , typename _device_t >
virtual float dx::stream::pin< _desc_t, _circular_t, _device_t >::encoder ( dx::stream::encoder::index::type type,
int index ) const
inlinevirtual
+ Here is the call graph for this function:

◆ info()

◆ initialize()

template<typename _desc_t , typename _circular_t , typename _device_t >
virtual pin & dx::stream::pin< _desc_t, _circular_t, _device_t >::initialize ( )
inlinevirtual

◆ launch()

◆ operator circular_t *()

template<typename _desc_t , typename _circular_t , typename _device_t >
virtual dx::stream::pin< _desc_t, _circular_t, _device_t >::operator circular_t * ( ) const
inlinevirtualnoexcept

◆ operator->()

template<typename _desc_t , typename _circular_t , typename _device_t >
virtual circular_t * dx::stream::pin< _desc_t, _circular_t, _device_t >::operator-> ( ) const
inlinevirtualnoexcept

◆ stop()

template<typename _desc_t , typename _circular_t , typename _device_t >
virtual void dx::stream::pin< _desc_t, _circular_t, _device_t >::stop ( bool force = false)
inlinevirtualnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ control

template<typename _desc_t , typename _circular_t , typename _device_t >
dx::stream::channel::control* dx::stream::pin< _desc_t, _circular_t, _device_t >::control = nullptr

◆ launched

bool dx::object::launched {}
inherited

◆ stream

template<typename _desc_t , typename _circular_t , typename _device_t >
stream_t& dx::stream::pin< _desc_t, _circular_t, _device_t >::stream

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

(c) copyright 2009 dynamic acoustics e.U. generated on Fri Dec 20 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.