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

#include <TypedPorts.h>

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

Public Member Functions
	TypedWritePort (WriteChannelPort &port)
	TypedWritePort (WriteChannelPort *port)
void	connect (const ChannelPort::ConnectOptions &opts={})
void	write (const T &data)
bool	tryWrite (const T &data)
bool	flush ()
void	disconnect ()
bool	isConnected () const
WriteChannelPort &	raw ()
const WriteChannelPort &	raw () const

Private Member Functions
void	checkValueRange (const T &data)

Private Attributes
WriteChannelPort *	inner
WireInfo	wireInfo_

Detailed Description

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

Definition at line 224 of file TypedPorts.h.

Constructor & Destructor Documentation

TypedWritePort() [1/2]

template<typename T , bool CheckValue = false>

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

inlineexplicit

Definition at line 226 of file TypedPorts.h.

TypedWritePort() [2/2]

template<typename T , bool CheckValue = false>

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

inline

Definition at line 228 of file TypedPorts.h.

Member Function Documentation

checkValueRange()

template<typename T , bool CheckValue = false>

void esi::TypedWritePort< T, CheckValue >::checkValueRange ( const T &  data )

inlineprivate

Definition at line 261 of file TypedPorts.h.

References esi::ChannelPort::getType(), esi::BitVectorType::getWidth(), esi::TypedWritePort< T, CheckValue >::inner, and esi::unwrapTypeAlias().

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

connect()

template<typename T , bool CheckValue = false>

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

inline

Definition at line 230 of file TypedPorts.h.

Referenced by runLoopbackI8().

disconnect()

template<typename T , bool CheckValue = false>

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

inline

Definition at line 251 of file TypedPorts.h.

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

flush()

template<typename T , bool CheckValue = false>

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

inline

Definition at line 250 of file TypedPorts.h.

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

isConnected()

template<typename T , bool CheckValue = false>

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

inline

Definition at line 252 of file TypedPorts.h.

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

raw() [1/2]

template<typename T , bool CheckValue = false>

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

inline

Definition at line 254 of file TypedPorts.h.

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

raw() [2/2]

template<typename T , bool CheckValue = false>

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

inline

Definition at line 255 of file TypedPorts.h.

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

tryWrite()

template<typename T , bool CheckValue = false>

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

inline

Definition at line 244 of file TypedPorts.h.

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

write()

template<typename T , bool CheckValue = false>

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

inline

Definition at line 238 of file TypedPorts.h.

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

Referenced by runLoopbackI8().

Member Data Documentation

inner

template<typename T , bool CheckValue = false>

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

private

Definition at line 258 of file TypedPorts.h.

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

wireInfo_

template<typename T , bool CheckValue = false>

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

private

Definition at line 259 of file TypedPorts.h.

Referenced by esi::TypedWritePort< T, CheckValue >::tryWrite(), and esi::TypedWritePort< T, CheckValue >::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