icarus::trigger::WindowChannelMap::WindowTopology_t Struct Reference

Information of the identity and neighbourhood of a window. More...

#include <WindowChannelMap.h>

Inheritance diagram for icarus::trigger::WindowChannelMap::WindowTopology_t:

Public Member Functions
bool	hasUpstreamWindow () const
	Returns whether the main window has another upstream of it. More...

bool	hasDownstreamWindow () const
	Returns whether the main window has another downstream of it. More...

bool	hasOppositeWindow () const
	Returns whether the main window has another downstream of it. More...

Public Attributes
WindowIndex_t	index
	Index of the window this information is about. More...

WindowIndex_t	opposite { InvalidWindowIndex }
	Index of the window opposite to this one. More...

WindowIndex_t	upstream { InvalidWindowIndex }
	Index of the window upstream of this one. More...

WindowIndex_t	downstream { InvalidWindowIndex }
	Index of the window downstream of this one. More...

Detailed Description

Information of the identity and neighbourhood of a window.

Definition at line 78 of file WindowChannelMap.h.

Member Function Documentation

bool icarus::trigger::WindowChannelMap::WindowTopology_t::hasDownstreamWindow ( ) const

inline

Returns whether the main window has another downstream of it.

Definition at line 95 of file WindowChannelMap.h.

95 { return isValidWindow(downstream); }

icarus::trigger::WindowChannelMap::WindowTopology_t::downstream

WindowIndex_t downstream

Index of the window downstream of this one.

Definition: WindowChannelMap.h:89

icarus::trigger::WindowChannelMap::isValidWindow

static bool isValidWindow(WindowIndex_t index)

Returns whether the specified index is not the invalid window index.

Definition: WindowChannelMap.h:162

bool icarus::trigger::WindowChannelMap::WindowTopology_t::hasOppositeWindow ( ) const

inline

Returns whether the main window has another downstream of it.

Definition at line 98 of file WindowChannelMap.h.

98 { return isValidWindow(opposite); }

icarus::trigger::WindowChannelMap::isValidWindow

static bool isValidWindow(WindowIndex_t index)

Returns whether the specified index is not the invalid window index.

Definition: WindowChannelMap.h:162

icarus::trigger::WindowChannelMap::WindowTopology_t::opposite

WindowIndex_t opposite

Index of the window opposite to this one.

Definition: WindowChannelMap.h:83

bool icarus::trigger::WindowChannelMap::WindowTopology_t::hasUpstreamWindow ( ) const

inline

Returns whether the main window has another upstream of it.

Definition at line 92 of file WindowChannelMap.h.

92 { return isValidWindow(upstream); }

icarus::trigger::WindowChannelMap::WindowTopology_t::upstream

WindowIndex_t upstream

Index of the window upstream of this one.

Definition: WindowChannelMap.h:86

icarus::trigger::WindowChannelMap::isValidWindow

static bool isValidWindow(WindowIndex_t index)

Returns whether the specified index is not the invalid window index.

Definition: WindowChannelMap.h:162

Member Data Documentation

WindowIndex_t icarus::trigger::WindowChannelMap::WindowTopology_t::downstream { InvalidWindowIndex }

Index of the window downstream of this one.

Definition at line 89 of file WindowChannelMap.h.

WindowIndex_t icarus::trigger::WindowChannelMap::WindowTopology_t::index

Index of the window this information is about.

Definition at line 80 of file WindowChannelMap.h.

WindowIndex_t icarus::trigger::WindowChannelMap::WindowTopology_t::opposite { InvalidWindowIndex }

Index of the window opposite to this one.

Definition at line 83 of file WindowChannelMap.h.

WindowIndex_t icarus::trigger::WindowChannelMap::WindowTopology_t::upstream { InvalidWindowIndex }

Index of the window upstream of this one.

Definition at line 86 of file WindowChannelMap.h.

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

WindowChannelMap.h