adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE > Class Template Reference

#include <samplereader.h>

Inherits INTERFACE.

Public Types
typedef PINTYPE	pin_type

Public Member Functions
	sample_streamer ()=default
	CTOR.
	sample_streamer (const char *strName, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
virtual	~sample_streamer ()
	DTOR.
void	SetName (const char *strName)
void	ResetPin (ucom::ant::object_ptr< PINTYPE > &pPin)
void	ResetPin ()
tResult	GetName (base::ant::IString &&strName) const
tResult	SetType (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
tResult	GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const override
tResult	EndStreaming () override

Protected Member Functions
	sample_streamer (const sample_streamer &)=delete
	deleted copy CTOR
	sample_streamer (sample_streamer &&)=delete
	deleted move CTOR
sample_streamer &	operator= (const sample_streamer &)=delete
	deleted copy operator
sample_streamer &	operator= (sample_streamer &&)=delete
	deleted move operator

Protected Attributes
adtf_util::cString	m_strName
	name of the streamer (used i.e. to create the pins name)
ucom::object_ptr< const IStreamType >	m_pStreamType
	stream type of the streamer
ucom::object_ptr< PINTYPE >	m_poPin
	pin reference reading/writing from

Detailed Description

template<typename INTERFACE, typename PINTYPE>
class adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >

Helper template can be used to implement ISampleStreamer. This template works only for cInPin and cOutPin or implementations using similar functionality to cPin::RegisterStreamer and cPin::UnregisterStreamer.

Template Parameters

PINTYPE

Pin referenced to.

Constructor & Destructor Documentation

sample_streamer()

template<typename INTERFACE, typename PINTYPE>

adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >::sample_streamer ( const char * strName, const ucom::ant::iobject_ptr< const IStreamType > & pStreamType )

inline

CTOR initializer

Parameters

[in]	strName	Name of the Streamer
[in]	pStreamType	Accepted streamtype of the streamer

Member Function Documentation

GetName()

template<typename INTERFACE, typename PINTYPE>

tResult adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >::GetName ( base::ant::IString && strName ) const

inline

Gets the name of the streamer.

Parameters

[out]

strName

IString Reference to return the name

Returns

Standard Result Code of base::IString::Set.

ResetPin() [1/2]

template<typename INTERFACE, typename PINTYPE>

void adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >::ResetPin ( )

inline

Resets the pin reference to nullptr. This is only internaly used.

Returns

void

ResetPin() [2/2]

template<typename INTERFACE, typename PINTYPE>

void adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >::ResetPin ( ucom::ant::object_ptr< PINTYPE > & pPin )

inline

Resets the pin reference This is only internaly used

Parameters

[in]

pPin

pin referencing to

Returns

void

SetName()

template<typename INTERFACE, typename PINTYPE>

void adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >::SetName ( const char * strName )

inline

Sets the name of the streamer

Parameters

[in]

strName

name to be set

Returns

void

SetType()

template<typename INTERFACE, typename PINTYPE>

tResult adtf::streaming::ant::sample_streamer< INTERFACE, PINTYPE >::SetType ( const ucom::ant::iobject_ptr< const IStreamType > & pStreamType )

inline

Sets the StreamType of the streamer. It will create a deep copy.

Parameters

[in]

pStreamType

StreamType to set.

Returns

Standard Result Code of base::IString::Set.

---

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

• src/libraries/streaming3/include/adtfstreaming3/samplereader.h