DdtViewer Class Reference

The DdtViewer class Main class of the DDT Standard Viewer. More...

#include <ddtViewer.hpp>

Inheritance diagram for DdtViewer:

Signals
void	AttachDataFile (QString filename)
void	AttachDataStream (QString data_stream)
void	DetachStream ()
void	PopulatePublisherListCombo (QString startup_localbroker_uri, QString startup_remotebroker_uri)
void	SetDataStream (QString startup_data_stream)
void	SetImageScale (const QString startup_image_scale)
void	SetNoWaitNewData (const bool startup_no_wait_new_data)
void	LoadOverlayFile (const QString startup_overlay_file)

Public Member Functions
template<typename Func1 , typename Func2 >
void	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot)
	connect Template version of QObject::connection with fixed Qt::QueuedConnection flag. Normally used to connect a signal with a lambda function.

Protected Attributes
ddt::DdtLogger	logger
std::unique_ptr< ddt::DdtRemoteControl >	remote_control
	DdtViewer (const char *exec_path, QWidget *parent=nullptr)
virtual	~DdtViewer ()
ddt::CommandLineParserResult	ParseCommandLine (int argc, char *argv[])
void	Init ()
void	LastSegment (void)
void	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
	connect Group of overloaded functions that use the QObject::connect method with the Qt::QueuedConnection flag. This defines Qt Signal and Slots connection the same way thought out the QApplication.
void	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
void	connect (const QObject *sender, const char *signal, const char *member)
void	HandleArguments ()
	HandleArguments Slot to handle commandline arguments after initialisation of the GUI.
void	ResetDockWidgetsLayout ()
	ResetDockWidgetsLayout Slot to handle the reconfiguration of dock widgets layout to default state.
void	closeEvent (QCloseEvent *event) override
	closeEvent Close event which is triggered when the main window shell be closed.

Detailed Description

The DdtViewer class Main class of the DDT Standard Viewer.

Constructor & Destructor Documentation

DdtViewer()

DdtViewer::DdtViewer ( const char * exec_path, QWidget * parent = nullptr )

explicit

Constructor

Parameters

exec_path	absolute path to the DDTViewer executable file - argv[0]
parent	Pointer to the parent widget.

~DdtViewer()

DdtViewer::~DdtViewer ( )

virtual

Destructor

Will be called when DDT Viewer is closed

Member Function Documentation

AttachDataFile

void DdtViewer::AttachDataFile ( QString filename )

signal

Signal that sends a filename of a file to open

Parameters

filename

filename and path of the file to open at startup

AttachDataStream

void DdtViewer::AttachDataStream ( QString data_stream )

signal

Signal that sends a stream URI to the image widget

Parameters

data_stream

URI of the data stream

closeEvent()

void DdtViewer::closeEvent ( QCloseEvent * event )

overrideprotected

closeEvent Close event which is triggered when the main window shell be closed.

Parameters

event

connect() [1/4]

void DdtViewer::connect	(	const QObject *	sender,
		const char *	signal,
		const char *	member )

connect() [2/4]

void DdtViewer::connect	(	const QObject *	sender,
		const char *	signal,
		const QObject *	receiver,
		const char *	member )

connect Group of overloaded functions that use the QObject::connect method with the Qt::QueuedConnection flag. This defines Qt Signal and Slots connection the same way thought out the QApplication.

Parameters

const	QObject* - sender
const	chat* - signal
const	QObject* - receiver
const	char* - member

connect() [3/4]

void DdtViewer::connect	(	const QObject *	sender,
		const QMetaMethod &	signal,
		const QObject *	receiver,
		const QMetaMethod &	method )

connect() [4/4]

template<typename Func1 , typename Func2 >

void DdtViewer::connect	(	const typename QtPrivate::FunctionPointer< Func1 >::Object *	sender,
		Func1	signal,
		const QObject *	context,
		Func2	slot )

connect Template version of QObject::connection with fixed Qt::QueuedConnection flag. Normally used to connect a signal with a lambda function.

Parameters

const	typename QtPrivate::FunctionPointer<Func1>::Object* - sender
typename	- signal
const	QObject* - context
typename	- slot

DetachStream

void DdtViewer::DetachStream ( )

signal

Signal that is sent to the image widget when the window closes

HandleArguments

void DdtViewer::HandleArguments ( )

slot

HandleArguments Slot to handle commandline arguments after initialisation of the GUI.

Init()

void DdtViewer::Init

(

)

Initializes a DDT Viewer object

LastSegment()

void DdtViewer::LastSegment

(

void

)

Function to be registered as callback in the ImageWidget. It will be called when an image is received in the ImageWidget that has the "last segment" flag set.

LoadOverlayFile

void DdtViewer::LoadOverlayFile ( const QString startup_overlay_file )

signal

Signal that sends the overlay file

Parameters

startup_overlay_file

The overlay file to load at startup

ParseCommandLine()

ddt::CommandLineParserResult DdtViewer::ParseCommandLine	(	int	argc,
		char *	argv[] )

Parse command line arguments

PopulatePublisherListCombo

void DdtViewer::PopulatePublisherListCombo ( QString startup_localbroker_uri, QString startup_remotebroker_uri )

signal

Signal that sends the startup localbroker uri

Parameters

startup_localbroker_uri	Local Broker URI used at startup
startup_remotebroker_uri	Remote Broker URI used at startup

ResetDockWidgetsLayout

void DdtViewer::ResetDockWidgetsLayout ( )

slot

ResetDockWidgetsLayout Slot to handle the reconfiguration of dock widgets layout to default state.

SetDataStream

void DdtViewer::SetDataStream ( QString startup_data_stream )

signal

Signal that sends the startup stream name

Parameters

startup_data_stream

Data Stream used at startup

SetImageScale

void DdtViewer::SetImageScale ( const QString startup_image_scale )

signal

Signal that sends the default image scale

Parameters

startup_image_scale

Image scale used at startup

SetNoWaitNewData

void DdtViewer::SetNoWaitNewData ( const bool startup_no_wait_new_data )

signal

Signal that sends the default no_wait_new_data flag

Parameters

startup_no_wait_new_data

Default no_wait_new_data flag used at startup

Member Data Documentation

logger

ddt::DdtLogger DdtViewer::logger

protected

Logger object

remote_control

std::unique_ptr<ddt::DdtRemoteControl> DdtViewer::remote_control

protected

Remote control interface

---

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

• datavisualisation/viewer/src/include/ddt/ddtViewer.hpp
• datavisualisation/viewer/src/ddtViewer.cpp