Class for managing all WOSS classes involved. More...

#include <woss-controller.h>

Collaboration diagram for woss::WossController:

Public Member Functions
	WossController ()=default

	WossController (WossController &copy)=default

WossController &	operator= (WossController &copy)=default

virtual	~WossController ()=default

bool	initialize ()

WossController &	setBathymetryDbCreator (const std::shared_ptr< WossDbCreator > &ptr)

WossController &	setSedimentDbCreator (const std::shared_ptr< WossDbCreator > &ptr)

WossController &	setSSPDbCreator (const std::shared_ptr< WossDbCreator > &ptr)

WossController &	setPressureDbCreator (const std::shared_ptr< WossDbCreator > &ptr)

WossController &	setTimeArrDbCreator (const std::shared_ptr< WossDbCreator > &ptr)

WossController &	setWossCreator (const std::shared_ptr< WossCreator > &ptr)

WossController &	setWossDbManager (const std::shared_ptr< WossDbManager > &ptr)

WossController &	setWossManager (const std::shared_ptr< WossManager > &ptr)

WossController &	setTransducerHandler (const std::shared_ptr< TransducerHandler > &ptr)

WossController &	setDebug (bool flag)

std::shared_ptr< WossDbCreator >	getBathymetryDbCreator () const

std::shared_ptr< WossDbCreator >	getSedimentDbCreator () const

std::shared_ptr< WossDbCreator >	getSSPDbCreator () const

std::shared_ptr< WossDbCreator >	getPressureDbCreator () const

std::shared_ptr< WossDbCreator >	getTimeArrDbCreator () const

std::shared_ptr< WossCreator >	getWossCreator () const

std::shared_ptr< WossDbManager >	getWossDbManager () const

std::shared_ptr< WossManager >	getWossManager () const

std::shared_ptr< TransducerHandler >	getTransducerHandler () const

bool	getDebug () const

Protected Attributes
double	debug = false

bool	initialized = false

std::shared_ptr< WossDbCreator >	bathymetry_db_creator = nullptr

std::shared_ptr< WossDbCreator >	sediment_db_creator = nullptr

std::shared_ptr< WossDbCreator >	ssp_db_creator = nullptr

std::shared_ptr< WossDbCreator >	pressure_result_db_creator = nullptr

std::shared_ptr< WossDbCreator >	timearr_result_db_creator = nullptr

std::shared_ptr< WossCreator >	woss_creator = nullptr

std::shared_ptr< WossDbManager >	woss_db_manager = nullptr

std::shared_ptr< WossManager >	woss_manager = nullptr

std::shared_ptr< TransducerHandler >	transducer_handler = nullptr

Detailed Description

Class for managing all WOSS classes involved.

woss::WossController is a class that sets all needed connections between primary WOSS classes. It should be used with woss::Singleton for safety reasons. ( e.g. woss::Singleton<woss::WossController> )

Constructor & Destructor Documentation

◆ WossController() [1/2]

woss::WossController::WossController ( )

default

Default constructor

◆ WossController() [2/2]

woss::WossController::WossController ( WossController & copy )

default

◆ ~WossController()

virtual woss::WossController::~WossController ( )

virtualdefault

Member Function Documentation

◆ getBathymetryDbCreator()

std::shared_ptr< WossDbCreator > woss::WossController::getBathymetryDbCreator ( ) const

inline

Returns the current BathymetryDbCreator object

Returns: a std::shared_ptr to a BathymetryDbCreator instance

References bathymetry_db_creator, and initialized.

◆ getDebug()

bool woss::WossController::getDebug ( ) const

inline

Returns the current debug flag

Returns: debug flag

References debug.

◆ getPressureDbCreator()

std::shared_ptr< WossDbCreator > woss::WossController::getPressureDbCreator ( ) const

inline

Returns the current PressureDbCreator object

Returns: a std::shared_ptr to a PressureDbCreator instance

References initialized, and pressure_result_db_creator.

◆ getSedimentDbCreator()

std::shared_ptr< WossDbCreator > woss::WossController::getSedimentDbCreator ( ) const

inline

Returns the current SedimentDbCreator object

Returns: a std::shared_ptr to a SedimentDbCreator instance

References initialized, and sediment_db_creator.

◆ getSSPDbCreator()

std::shared_ptr< WossDbCreator > woss::WossController::getSSPDbCreator ( ) const

inline

Returns the current SSPDbCreator object

Returns: a std::shared_ptr to a SSPDbCreator instance

References initialized, and ssp_db_creator.

◆ getTimeArrDbCreator()

std::shared_ptr< WossDbCreator > woss::WossController::getTimeArrDbCreator ( ) const

inline

Returns the current TimeArrDbCreator object

Returns: a std::shared_ptr to a TimeArrDbCreator instance

References initialized, and timearr_result_db_creator.

◆ getTransducerHandler()

std::shared_ptr< TransducerHandler > woss::WossController::getTransducerHandler ( ) const

inline

Returns the current TransducerHandler object

Returns: a std::shared_ptr to a TransducerHandler instance

References initialized, and transducer_handler.

◆ getWossCreator()

std::shared_ptr< WossCreator > woss::WossController::getWossCreator ( ) const

inline

Returns the current WossCreator object

Returns: a std::shared_ptr to a WossCreator instance

References initialized, and woss_creator.

◆ getWossDbManager()

std::shared_ptr< WossDbManager > woss::WossController::getWossDbManager ( ) const

inline

Returns the current WossDbManager object

Returns: a std::shared_ptr to a WossDbManager instance

References initialized, and woss_db_manager.

◆ getWossManager()

std::shared_ptr< WossManager > woss::WossController::getWossManager ( ) const

inline

Returns the current WossManager object

Returns: a std::shared_ptr to a WossManager instance

References initialized, and woss_manager.

◆ initialize()

bool WossController::initialize ( )

Initializes all connections

References bathymetry_db_creator, initialized, pressure_result_db_creator, sediment_db_creator, ssp_db_creator, timearr_result_db_creator, transducer_handler, woss_creator, woss_db_manager, and woss_manager.

◆ operator=()

WossController & woss::WossController::operator= ( WossController & copy )

default

◆ setBathymetryDbCreator()

WossController & woss::WossController::setBathymetryDbCreator ( const std::shared_ptr< WossDbCreator > & ptr )

inline

Configures the BathymetryDbCreator object

Parameters

ptr	a const reference to a std::shared_ptr to a BathymetryDbCreator instance

Returns: a reference to *this

References bathymetry_db_creator.

◆ setDebug()

WossController & woss::WossController::setDebug ( bool flag )

inline

Configures the debug flag

Parameters

ptr	a const reference to a std::shared_ptr to a WossManager instance

Returns: a reference to *this

References debug.

◆ setPressureDbCreator()

WossController & woss::WossController::setPressureDbCreator ( const std::shared_ptr< WossDbCreator > & ptr )

inline

Configures the PressureDbCreator object

Parameters

ptr	a const reference to a std::shared_ptr to a PressureDbCreator instance

Returns: a reference to *this

References pressure_result_db_creator.

◆ setSedimentDbCreator()

WossController & woss::WossController::setSedimentDbCreator ( const std::shared_ptr< WossDbCreator > & ptr )

inline

Configures the SedimentDbCreator object

Parameters

ptr	a const reference to a std::shared_ptr to a SedimentDbCreator instance

Returns: a reference to *this

References sediment_db_creator.

◆ setSSPDbCreator()

WossController & woss::WossController::setSSPDbCreator ( const std::shared_ptr< WossDbCreator > & ptr )

inline

Configures the SSPDbCreator object

Parameters

ptr	a const reference to a std::shared_ptr to a SSPDbCreator instance

Returns: a reference to *this

References ssp_db_creator.

◆ setTimeArrDbCreator()

WossController & woss::WossController::setTimeArrDbCreator ( const std::shared_ptr< WossDbCreator > & ptr )

inline

Configures the TimeArrDbCreator object

Parameters

ptr	a const reference to a std::shared_ptr to a BathymetryDbCreator instance

Returns: a reference to *this

References timearr_result_db_creator.

◆ setTransducerHandler()

WossController & woss::WossController::setTransducerHandler ( const std::shared_ptr< TransducerHandler > & ptr )

inline

Configures the TransducerHandler object

Parameters

ptr	a const reference to a std::shared_ptr to a TransducerHandler instance

Returns: a reference to *this

References transducer_handler.

◆ setWossCreator()

WossController & woss::WossController::setWossCreator ( const std::shared_ptr< WossCreator > & ptr )

inline

Configures the WossCreator object

Parameters

ptr	a const reference to a std::shared_ptr to a WossCreator instance

Returns: a reference to *this

References woss_creator.

◆ setWossDbManager()

WossController & woss::WossController::setWossDbManager ( const std::shared_ptr< WossDbManager > & ptr )

inline

Configures the WossDbManager object

Parameters

ptr	a const reference to a std::shared_ptr to a WossDbManager instance

Returns: a reference to *this

References woss_db_manager.

◆ setWossManager()

WossController & woss::WossController::setWossManager ( const std::shared_ptr< WossManager > & ptr )

inline

Configures the WossManager object

Parameters

ptr	a const reference to a std::shared_ptr to a WossManager instance

Returns: a reference to *this

References woss_manager.

Member Data Documentation

◆ bathymetry_db_creator

std::shared_ptr<WossDbCreator> woss::WossController::bathymetry_db_creator = nullptr

protected

std::shared_ptr of the current BathymetryDbCreator

Referenced by getBathymetryDbCreator(), initialize(), and setBathymetryDbCreator().

◆ debug

double woss::WossController::debug = false

protected

Debug flag

Referenced by getDebug(), and setDebug().

◆ initialized

bool woss::WossController::initialized = false

protected

Initialized flag

Referenced by getBathymetryDbCreator(), getPressureDbCreator(), getSedimentDbCreator(), getSSPDbCreator(), getTimeArrDbCreator(), getTransducerHandler(), getWossCreator(), getWossDbManager(), getWossManager(), and initialize().

◆ pressure_result_db_creator

std::shared_ptr<WossDbCreator> woss::WossController::pressure_result_db_creator = nullptr

protected

std::shared_ptr of the current PressureDbCreator

Referenced by getPressureDbCreator(), initialize(), and setPressureDbCreator().

◆ sediment_db_creator

std::shared_ptr<WossDbCreator> woss::WossController::sediment_db_creator = nullptr

protected

std::shared_ptr of the current SedimentDbCreator

Referenced by getSedimentDbCreator(), initialize(), and setSedimentDbCreator().

◆ ssp_db_creator

std::shared_ptr<WossDbCreator> woss::WossController::ssp_db_creator = nullptr

protected

std::shared_ptr of the current SSPDbCreator

Referenced by getSSPDbCreator(), initialize(), and setSSPDbCreator().

◆ timearr_result_db_creator

std::shared_ptr<WossDbCreator> woss::WossController::timearr_result_db_creator = nullptr

protected

std::shared_ptr of the current TimeArrDbCreator

Referenced by getTimeArrDbCreator(), initialize(), and setTimeArrDbCreator().

◆ transducer_handler

std::shared_ptr<TransducerHandler> woss::WossController::transducer_handler = nullptr

protected

std::shared_ptr of the current TransducerHandler

Referenced by getTransducerHandler(), initialize(), and setTransducerHandler().

◆ woss_creator

std::shared_ptr<WossCreator> woss::WossController::woss_creator = nullptr

protected

std::shared_ptr of the current WossCreator

Referenced by getWossCreator(), initialize(), and setWossCreator().

◆ woss_db_manager

std::shared_ptr<WossDbManager> woss::WossController::woss_db_manager = nullptr

protected

std::shared_ptr of the current WossDbManager

Referenced by getWossDbManager(), initialize(), and setWossDbManager().

◆ woss_manager

std::shared_ptr<WossManager> woss::WossController::woss_manager = nullptr

protected

std::shared_ptr of the current WossManager

Referenced by getWossManager(), initialize(), and setWossManager().

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

woss/woss-controller.h
woss/woss-controller.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WossController() [1/2]

◆ WossController() [2/2]

◆ ~WossController()

Member Function Documentation

◆ getBathymetryDbCreator()

◆ getDebug()

◆ getPressureDbCreator()

◆ getSedimentDbCreator()

◆ getSSPDbCreator()

◆ getTimeArrDbCreator()

◆ getTransducerHandler()

◆ getWossCreator()

◆ getWossDbManager()

◆ getWossManager()

◆ initialize()

◆ operator=()

◆ setBathymetryDbCreator()

◆ setDebug()

◆ setPressureDbCreator()

◆ setSedimentDbCreator()

◆ setSSPDbCreator()

◆ setTimeArrDbCreator()

◆ setTransducerHandler()

◆ setWossCreator()

◆ setWossDbManager()

◆ setWossManager()

Member Data Documentation

◆ bathymetry_db_creator

◆ debug

◆ initialized

◆ pressure_result_db_creator

◆ sediment_db_creator

◆ ssp_db_creator

◆ timearr_result_db_creator

◆ transducer_handler

◆ woss_creator

◆ woss_db_manager

◆ woss_manager