dw::framework::ChannelParams Class Reference

Detailed Description

Class to hold the parsed Channel parameters.

Definition at line 676 of file ChannelParameters.hpp.

Public Member Functions
	ChannelParams (const ChannelParams &other)=default
	ChannelParams (const char *params)
uint32_t	getConnectGroupID () const
uint32_t	getDataOffset () const
bool	getDebugMode () const
uint16_t	getDebugPort () const
uint16_t	getExpectedConnectionsCount () const
uint16_t	getExpectedDebugConnectionsCount () const
size_t	getFifoSize () const
const ChannelFSIParams &	getFSIParams () const
ChannelParamStr	getId () const
bool	getMailboxMode () const
ChannelParamStr	getName () const
const ChannelNvSciStreamParams &	getNvSciStreamParams () const
size_t	getPoolCapacity () const
bool	getReuseEnabled () const
ChannelRole	getRole () const
ChannelParamStr	getSingletonId () const
bool	getSingletonMode () const
const ChannelSocketParams &	getSocketParams () const
const char *	getStr () const
bool	getSyncEnabled () const
const ChannelParamStr &	getSyncObjectId () const
ChannelType	getType () const
uint32_t	getUID () const
bool	hasProducerFifo () const
bool	isStrictFifo () const
ChannelParams &	operator= (const ChannelParams &other)=default
void	setFifoSize (size_t fifoSize)
void	setMailboxMode (bool mailboxEnabled)
void	setStrictFifo (bool strictFifo)
	~ChannelParams ()=default

Constructor & Destructor Documentation

ChannelParams() [1/2]

dw::framework::ChannelParams::ChannelParams ( const char *  params )

inlineexplicit

Definition at line 679 of file ChannelParameters.hpp.

References dw::framework::DDS, dw::framework::EGLSTREAM, dw::framework::FSI, dw::framework::MAILBOX, dw::framework::NVSCI, dw::framework::ParseAllChannelParameters(), dw::framework::SHMEM_LOCAL, dw::framework::SHMEM_REMOTE, dw::framework::SINGLETON, and dw::framework::SOCKET.

ChannelParams() [2/2]

dw::framework::ChannelParams::ChannelParams ( const ChannelParams &  other )

default

~ChannelParams()

dw::framework::ChannelParams::~ChannelParams ( )

default

Member Function Documentation

getConnectGroupID()

uint32_t dw::framework::ChannelParams::getConnectGroupID ( ) const

inline

Definition at line 799 of file ChannelParameters.hpp.

getDataOffset()

uint32_t dw::framework::ChannelParams::getDataOffset ( ) const

inline

Definition at line 787 of file ChannelParameters.hpp.

getDebugMode()

bool dw::framework::ChannelParams::getDebugMode ( ) const

inline

Definition at line 793 of file ChannelParameters.hpp.

getDebugPort()

uint16_t dw::framework::ChannelParams::getDebugPort ( ) const

inline

Definition at line 765 of file ChannelParameters.hpp.

getExpectedConnectionsCount()

uint16_t dw::framework::ChannelParams::getExpectedConnectionsCount ( ) const

inline

Definition at line 794 of file ChannelParameters.hpp.

getExpectedDebugConnectionsCount()

uint16_t dw::framework::ChannelParams::getExpectedDebugConnectionsCount ( ) const

inline

Definition at line 795 of file ChannelParameters.hpp.

getFifoSize()

size_t dw::framework::ChannelParams::getFifoSize ( ) const

inline

Definition at line 767 of file ChannelParameters.hpp.

getFSIParams()

const ChannelFSIParams & dw::framework::ChannelParams::getFSIParams ( ) const

inline

Definition at line 822 of file ChannelParameters.hpp.

References dw::framework::FSI.

getId()

ChannelParamStr dw::framework::ChannelParams::getId ( ) const

inline

Definition at line 762 of file ChannelParameters.hpp.

getMailboxMode()

bool dw::framework::ChannelParams::getMailboxMode ( ) const

inline

Definition at line 779 of file ChannelParameters.hpp.

getName()

ChannelParamStr dw::framework::ChannelParams::getName ( ) const

inline

Definition at line 802 of file ChannelParameters.hpp.

getNvSciStreamParams()

const ChannelNvSciStreamParams & dw::framework::ChannelParams::getNvSciStreamParams ( ) const

inline

Definition at line 813 of file ChannelParameters.hpp.

References dw::framework::NVSCI.

getPoolCapacity()

size_t dw::framework::ChannelParams::getPoolCapacity ( ) const

inline

Definition at line 778 of file ChannelParameters.hpp.

Referenced by dw::framework::SyncPortHelperOutput< T >::parseDataSynced(), and dw::framework::SyncPortHelperInput< T >::parseDataSynced().

getReuseEnabled()

bool dw::framework::ChannelParams::getReuseEnabled ( ) const

inline

Definition at line 791 of file ChannelParameters.hpp.

Referenced by dw::framework::PortInput< T >::bindChannel().

getRole()

ChannelRole dw::framework::ChannelParams::getRole ( ) const

inline

Definition at line 796 of file ChannelParameters.hpp.

getSingletonId()

ChannelParamStr dw::framework::ChannelParams::getSingletonId ( ) const

inline

Definition at line 763 of file ChannelParameters.hpp.

getSingletonMode()

bool dw::framework::ChannelParams::getSingletonMode ( ) const

inline

Definition at line 790 of file ChannelParameters.hpp.

getSocketParams()

const ChannelSocketParams & dw::framework::ChannelParams::getSocketParams ( ) const

inline

Definition at line 804 of file ChannelParameters.hpp.

References dw::framework::SOCKET.

getStr()

const char * dw::framework::ChannelParams::getStr ( ) const

inline

Definition at line 761 of file ChannelParameters.hpp.

getSyncEnabled()

bool dw::framework::ChannelParams::getSyncEnabled ( ) const

inline

Definition at line 788 of file ChannelParameters.hpp.

getSyncObjectId()

const ChannelParamStr & dw::framework::ChannelParams::getSyncObjectId ( ) const

inline

Definition at line 764 of file ChannelParameters.hpp.

getType()

ChannelType dw::framework::ChannelParams::getType ( ) const

inline

Definition at line 797 of file ChannelParameters.hpp.

Referenced by dw::framework::PortOutput< T >::bindChannelForPODTypePacket().

getUID()

uint32_t dw::framework::ChannelParams::getUID ( ) const

inline

Definition at line 798 of file ChannelParameters.hpp.

hasProducerFifo()

bool dw::framework::ChannelParams::hasProducerFifo ( ) const

inline

Definition at line 766 of file ChannelParameters.hpp.

isStrictFifo()

bool dw::framework::ChannelParams::isStrictFifo ( ) const

inline

Definition at line 773 of file ChannelParameters.hpp.

operator=()

ChannelParams & dw::framework::ChannelParams::operator= ( const ChannelParams &  other )

default

setFifoSize()

void dw::framework::ChannelParams::setFifoSize ( size_t  fifoSize )

inline

Definition at line 768 of file ChannelParameters.hpp.

setMailboxMode()

void dw::framework::ChannelParams::setMailboxMode ( bool  mailboxEnabled )

inline

Definition at line 789 of file ChannelParameters.hpp.

setStrictFifo()

void dw::framework::ChannelParams::setStrictFifo ( bool  strictFifo )

inline

Definition at line 774 of file ChannelParameters.hpp.

---

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

• src/dwcgf/channel/ChannelParameters.hpp