Helpers.h File Reference

#include "rogue/Directives.h"

Go to the source code of this file.

Namespaces
namespace	rogue

Macros
#define	rogueStreamConnect(src, dst)   src->addSlave(dst);
	Connect a stream master to a downstream stream slave.
#define	rogueStreamTap(src, dst)   src->addSlave(dst);
	Deprecated alias for rogueStreamConnect.
#define	rogueStreamConnectBiDir(devA, devB)
	Connect two stream endpoints in both directions.
#define	rogueBusConnect(src, dst)   src->setSlave(dst);
	Connect a memory master to a memory slave.
#define	ROGUE_DEFAULT_TIMEOUT   1000000
	Default timeout in microseconds used by Rogue helper APIs.

Functions
void	rogue::defaultTimeout (struct timeval &tout)
	Returns Rogue default timeout as a timeval.

Macro Definition Documentation

ROGUE_DEFAULT_TIMEOUT

#define ROGUE_DEFAULT_TIMEOUT   1000000

Default timeout in microseconds used by Rogue helper APIs.

Definition at line 41 of file Helpers.h.

rogueBusConnect

#define rogueBusConnect	(		src,
			dst
	)		src->setSlave(dst);

Connect a memory master to a memory slave.

Definition at line 37 of file Helpers.h.

rogueStreamConnect

#define rogueStreamConnect	(		src,
			dst
	)		src->addSlave(dst);

Connect a stream master to a downstream stream slave.

---

Company : SLAC National Accelerator Laboratory

Description:

Helper functions for Rogue

This file is part of the rogue software platform. It is subject to the license terms in the LICENSE.txt file found in the top-level directory of this distribution and at: https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part of the rogue software platform, including this file, may be copied, modified, propagated, or distributed except according to the terms

contained in the LICENSE.txt file.

Definition at line 23 of file Helpers.h.

rogueStreamConnectBiDir

#define rogueStreamConnectBiDir	(		devA,
			devB
	)

Value:

    devA->addSlave(devB);                   \
    devB->addSlave(devA);

Connect two stream endpoints in both directions.

Definition at line 31 of file Helpers.h.

rogueStreamTap

#define rogueStreamTap	(		src,
			dst
	)		src->addSlave(dst);

Deprecated alias for rogueStreamConnect.

Definition at line 27 of file Helpers.h.