dw::framework::ManagedPortOutput< T > Class Template Reference

Detailed Description

template<typename T>
class dw::framework::ManagedPortOutput< T >

Derived ManagedPortOutput<T> provides type-specific interfaces for accessing buffers.

Definition at line 311 of file ManagedPort.hpp.

Inheritance diagram for dw::framework::ManagedPortOutput< T >:

Collaboration diagram for dw::framework::ManagedPortOutput< T >:

Public Member Functions
auto	getBuffer ()
template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID==DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>
	ManagedPortOutput ()
template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID==DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>
	ManagedPortOutput (ConstructProperties props)
template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID !=DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>
	ManagedPortOutput (ConstructProperties props, SpecimenT &ref)
template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID !=DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>
	ManagedPortOutput (SpecimenT &ref)
Public Member Functions inherited from dw::framework::ManagedPortOutputBase
void	acquire ()
void	bindChannel (ChannelObject *channel) override
const Properties &	getProperties () const noexcept
bool	isBound () const noexcept override
bool	isBufferAvailable () const noexcept
void	send ()
Public Member Functions inherited from dw::framework::ManagedPortBase
virtual void	bindChannel (ChannelObject *channel)=0
virtual bool	isBound () const noexcept=0
	ManagedPortBase ()
	ManagedPortBase (const ManagedPortBase &other)=delete
	ManagedPortBase (ManagedPortBase &&other)=delete
ManagedPortBase &	operator= (const ManagedPortBase &other)=delete
ManagedPortBase &	operator= (ManagedPortBase &&other)=delete
virtual void	reset ()
void	setCycleCount (uint32_t cycleCount)
virtual	~ManagedPortBase ()=default
Public Member Functions inherited from dw::framework::PortBase
virtual	~PortBase ()=default

Additional Inherited Members
Protected Member Functions inherited from dw::framework::ManagedPortOutputBase
GenericData	getBufferGeneric ()
	ManagedPortOutputBase (ConstructProperties props, GenericDataReference &&ref)
Protected Attributes inherited from dw::framework::ManagedPortBase
uint32_t	m_cycleCount

Constructor & Destructor Documentation

ManagedPortOutput() [1/4]

template<typename T >

template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID !=DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>

dw::framework::ManagedPortOutput< T >::ManagedPortOutput ( ConstructProperties  props, SpecimenT &  ref  )

inline

Parameters

[in]	props	the properties of the output Port.
[in]	ref	the reference data to be used by channel to allocate packets.

Definition at line 326 of file ManagedPort.hpp.

ManagedPortOutput() [2/4]

template<typename T >

template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID !=DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>

dw::framework::ManagedPortOutput< T >::ManagedPortOutput ( SpecimenT &  ref )

inline

Parameters

[in]

ref

the reference data to be used by channel to allocate packets.

Definition at line 336 of file ManagedPort.hpp.

ManagedPortOutput() [3/4]

template<typename T >

template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID==DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>

dw::framework::ManagedPortOutput< T >::ManagedPortOutput ( ConstructProperties  props )

inline

Parameters

[in]

props

the properties of the output Port.

Definition at line 345 of file ManagedPort.hpp.

ManagedPortOutput() [4/4]

template<typename T >

template<typename T2 = T, typename std::enable_if_t< parameter_traits< T2 >::PacketTID==DWFRAMEWORK_PACKET_ID_DEFAULT, void > * = nullptr>

dw::framework::ManagedPortOutput< T >::ManagedPortOutput ( )

inline

Definition at line 351 of file ManagedPort.hpp.

Member Function Documentation

getBuffer()

template<typename T >

auto dw::framework::ManagedPortOutput< T >::getBuffer ( )

inline

Get a pointer to the acquired buffer.

Note

returned pointer is never nullptr

Exceptions

when	the buffer cannot be cast to T.

Definition at line 361 of file ManagedPort.hpp.

---

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

• src/dwcgf/port/ManagedPort.hpp