esi::TypedWritePort< T, SkipTypeCheck > Class Template Reference

#include <TypedPorts.h>

Collaboration diagram for esi::TypedWritePort< T, SkipTypeCheck >:

Public Member Functions
	TypedWritePort (WriteChannelPort &port)
	TypedWritePort (WriteChannelPort *port)
void	connect (const ChannelPort::ConnectOptions &opts={})
void	write (const T &data)
void	write (std::unique_ptr< T > &data)
	Write by taking ownership.
bool	tryWrite (const T &data)
bool	flush ()
void	disconnect ()
bool	isConnected () const
WriteChannelPort &	raw ()
const WriteChannelPort &	raw () const

Private Attributes
WriteChannelPort *	inner
WireInfo	wireInfo_

Detailed Description

template<typename T, bool SkipTypeCheck = false>
class esi::TypedWritePort< T, SkipTypeCheck >

Definition at line 227 of file TypedPorts.h.

Constructor & Destructor Documentation

TypedWritePort() [1/2]

template<typename T , bool SkipTypeCheck = false>

esi::TypedWritePort< T, SkipTypeCheck >::TypedWritePort ( WriteChannelPort &  port )

inlineexplicit

Definition at line 229 of file TypedPorts.h.

TypedWritePort() [2/2]

template<typename T , bool SkipTypeCheck = false>

esi::TypedWritePort< T, SkipTypeCheck >::TypedWritePort ( WriteChannelPort *  port )

inline

Definition at line 231 of file TypedPorts.h.

Member Function Documentation

connect()

template<typename T , bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::connect ( const ChannelPort::ConnectOptions &  opts = {} )

inline

Definition at line 233 of file TypedPorts.h.

Referenced by runLoopbackI8(), serialCoordTranslateTest(), and serialCoordTranslateTest().

disconnect()

template<typename T , bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::disconnect ( )

inline

Definition at line 262 of file TypedPorts.h.

References esi::WriteChannelPort::disconnect(), and esi::TypedWritePort< T, SkipTypeCheck >::inner.

Referenced by serialCoordTranslateTest(), and serialCoordTranslateTest().

flush()

template<typename T , bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::flush ( )

inline

Definition at line 261 of file TypedPorts.h.

References esi::WriteChannelPort::flush(), and esi::TypedWritePort< T, SkipTypeCheck >::inner.

isConnected()

template<typename T , bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::isConnected ( ) const

inline

Definition at line 263 of file TypedPorts.h.

References esi::TypedWritePort< T, SkipTypeCheck >::inner, and esi::WriteChannelPort::isConnected().

raw() [1/2]

template<typename T , bool SkipTypeCheck = false>

WriteChannelPort & esi::TypedWritePort< T, SkipTypeCheck >::raw ( )

inline

Definition at line 265 of file TypedPorts.h.

References esi::TypedWritePort< T, SkipTypeCheck >::inner.

raw() [2/2]

template<typename T , bool SkipTypeCheck = false>

const WriteChannelPort & esi::TypedWritePort< T, SkipTypeCheck >::raw ( ) const

inline

Definition at line 266 of file TypedPorts.h.

References esi::TypedWritePort< T, SkipTypeCheck >::inner.

tryWrite()

template<typename T , bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::tryWrite ( const T &  data )

inline

Definition at line 257 of file TypedPorts.h.

References esi::TypedWritePort< T, SkipTypeCheck >::inner, esi::toMessageData(), esi::WriteChannelPort::tryWrite(), and esi::TypedWritePort< T, SkipTypeCheck >::wireInfo_.

write() [1/2]

template<typename T , bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::write ( const T &  data )

inline

Definition at line 242 of file TypedPorts.h.

References esi::TypedWritePort< T, SkipTypeCheck >::inner, esi::toMessageData(), esi::TypedWritePort< T, SkipTypeCheck >::wireInfo_, and esi::WriteChannelPort::write().

Referenced by runLoopbackI8(), serialCoordTranslateTest(), serialCoordTranslateTest(), and esi::TypedWritePort< T, SkipTypeCheck >::write().

write() [2/2]

template<typename T , bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::write ( std::unique_ptr< T > &  data )

inline

Write by taking ownership.

If T is a SegmentedMessageData, this hands the message directly to the port's segmented write path.

Definition at line 246 of file TypedPorts.h.

References esi::TypedWritePort< T, SkipTypeCheck >::inner, esi::WriteChannelPort::write(), and esi::TypedWritePort< T, SkipTypeCheck >::write().

Member Data Documentation

inner

template<typename T , bool SkipTypeCheck = false>

WriteChannelPort* esi::TypedWritePort< T, SkipTypeCheck >::inner

private

Definition at line 269 of file TypedPorts.h.

Referenced by esi::TypedWritePort< T, SkipTypeCheck >::disconnect(), esi::TypedWritePort< void >::disconnect(), esi::TypedWritePort< T, SkipTypeCheck >::flush(), esi::TypedWritePort< void >::flush(), esi::TypedWritePort< T, SkipTypeCheck >::isConnected(), esi::TypedWritePort< void >::isConnected(), esi::TypedWritePort< T, SkipTypeCheck >::raw(), esi::TypedWritePort< void >::raw(), esi::TypedWritePort< T, SkipTypeCheck >::raw(), esi::TypedWritePort< void >::raw(), esi::TypedWritePort< void >::tryWrite(), esi::TypedWritePort< T, SkipTypeCheck >::tryWrite(), esi::TypedWritePort< void >::write(), esi::TypedWritePort< T, SkipTypeCheck >::write(), and esi::TypedWritePort< T, SkipTypeCheck >::write().

wireInfo_

template<typename T , bool SkipTypeCheck = false>

WireInfo esi::TypedWritePort< T, SkipTypeCheck >::wireInfo_

private

Definition at line 270 of file TypedPorts.h.

Referenced by esi::TypedWritePort< T, SkipTypeCheck >::tryWrite(), and esi::TypedWritePort< T, SkipTypeCheck >::write().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/TypedPorts.h