Interface class for all modules of dispatching system. More...

#include <DispatchingModuleInterface.h>

Inheritance diagram for DispatchingModuleInterface:

[legend]

Public Member Functions
	DispatchingModuleInterface ()

virtual	~DispatchingModuleInterface ()

virtual bool	Init (DispatchingModuleManager *manager)=0

virtual ds_string	GetName ()=0

virtual ds_string	GetVersion ()=0

void	Enable ()

void	Disable ()

bool	IsEnabled () const

virtual void	RestartTimer (DS_Event &event)

virtual bool	SendString (DS_Event &event, ds_string &sendString, bool &forceImmediateSending)=0

virtual bool	PostSendString (DS_Event &event, ds_string &sendString, ds_StringList &sendStringList, bool &forceImmediateSending)=0

	DispatchingModuleInterface ()

virtual	~DispatchingModuleInterface ()

virtual bool	Init (DispatchingModuleManager *manager)=0

virtual ds_string	GetName ()=0

virtual ds_string	GetVersion ()=0

void	Enable ()

void	Disable ()

bool	IsEnabled () const

virtual void	RestartTimer (DS_Event &event)

virtual bool	SendString (DS_Event &event, ds_string &sendString, bool &forceImmediateSending)=0

virtual bool	PostSendString (DS_Event &event, ds_string &sendString, ds_StringList &sendStringList, bool &forceImmediateSending)=0

Detailed Description

Interface class for all modules of dispatching system.

Note: It IS required to rebuild all plugins, when this class is modified incompatible way.

Author: Stanislav Piecka

Constructor & Destructor Documentation

◆ DispatchingModuleInterface() [1/2]

INTERNAL DispatchingModuleInterface::DispatchingModuleInterface ( )

Returns

◆ ~DispatchingModuleInterface() [1/2]

DispatchingModuleInterface::~DispatchingModuleInterface ( )

virtual

Returns

◆ DispatchingModuleInterface() [2/2]

DispatchingModuleInterface::DispatchingModuleInterface ( )

Returns

◆ ~DispatchingModuleInterface() [2/2]

virtual DispatchingModuleInterface::~DispatchingModuleInterface ( )

virtual

Returns

Member Function Documentation

◆ Disable() [1/2]

void DispatchingModuleInterface::Disable ( )

Method disables plugin.

Note: Value is changed also in Init function.

Here is the caller graph for this function:

◆ Disable() [2/2]

void DispatchingModuleInterface::Disable ( )

Method disables plugin.

Note: Value is changed also in Init function.

◆ Enable() [1/2]

void DispatchingModuleInterface::Enable ( )

Method enables plugin.

Note: Value is changed also in Init function.

Here is the caller graph for this function:

◆ Enable() [2/2]

void DispatchingModuleInterface::Enable ( )

Method enables plugin.

Note: Value is changed also in Init function.

◆ GetName() [1/2]

virtual ds_string DispatchingModuleInterface::GetName ( )

pure virtual

Pure virtual method returns name of plugin. This method is implemented in ancestor.

Note: value is valid after Init function is called.

Returns: name of plugin

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

◆ GetName() [2/2]

virtual ds_string DispatchingModuleInterface::GetName ( )

pure virtual

Pure virtual method returns name of plugin. This method is implemented in ancestor.

Note: value is valid after Init function is called.

Returns: name of plugin

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

◆ GetVersion() [1/2]

virtual ds_string DispatchingModuleInterface::GetVersion ( )

pure virtual

Pure virtual method returns version of plugin in form to be sent. This method is implemented in ancestor.

Note: value is valid after Init function is called.

Returns: version of plugin

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

Here is the caller graph for this function:

◆ GetVersion() [2/2]

virtual ds_string DispatchingModuleInterface::GetVersion ( )

pure virtual

Pure virtual method returns version of plugin in form to be sent. This method is implemented in ancestor.

Note: value is valid after Init function is called.

Returns: version of plugin

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

◆ Init() [1/2]

virtual bool DispatchingModuleInterface::Init ( DispatchingModuleManager * manager )

pure virtual

Pure virtual method reads configuration file and initializes plugin.

Returns: true when configuration has been successfully loaded, false otherwise

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

Here is the caller graph for this function:

◆ Init() [2/2]

virtual bool DispatchingModuleInterface::Init ( DispatchingModuleManager * manager )

pure virtual

Pure virtual method reads configuration file and initializes plugin.

Returns: true when configuration has been successfully loaded, false otherwise

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

◆ IsEnabled() [1/2]

bool DispatchingModuleInterface::IsEnabled ( ) const

Method returns status of plugin.

Note: Value is valid after Init or Enable or Disable function is called.

Returns: true when plugin is currently enabled, false otherwise

Here is the caller graph for this function:

◆ IsEnabled() [2/2]

bool DispatchingModuleInterface::IsEnabled ( ) const

Method returns status of plugin.

Note: Value is valid after Init or Enable or Disable function is called.

Returns: true when plugin is currently enabled, false otherwise

◆ PostSendString() [1/2]

virtual bool DispatchingModuleInterface::PostSendString	(	DS_Event &	event,
		ds_string &	sendString,
		ds_StringList &	sendStringList,
		bool &	forceImmediateSending
	)

pure virtual

Pure virtual method allows to append some data to sendString which was prepared/modified by plugin in SendString method. This method is implemented in ancestor.

Parameters

event	occurent event to be handled
sendString	modified string by plugin
forceImmediateSending	plugin can set this to true to ensure immediate sending message to dispatching

Returns: true when all went OK, false otherwise.

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

Here is the caller graph for this function:

◆ PostSendString() [2/2]

virtual bool DispatchingModuleInterface::PostSendString	(	DS_Event &	event,
		ds_string &	sendString,
		ds_StringList &	sendStringList,
		bool &	forceImmediateSending
	)

pure virtual

Pure virtual method allows to append some data to sendString which was prepared/modified by plugin in SendString method. This method is implemented in ancestor.

Parameters

event	occurent event to be handled
sendString	modified string by plugin
forceImmediateSending	plugin can set this to true to ensure immediate sending message to dispatching

Returns: true when all went OK, false otherwise.

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

◆ RestartTimer() [1/2]

void DispatchingModuleInterface::RestartTimer ( DS_Event & event )

virtual

Method ask to restart timer of plugin, if plugin should restart it's timer on such event.

Parameters

event event generating restart timer request

Reimplemented in DS_Gps.

Here is the caller graph for this function:

◆ RestartTimer() [2/2]

virtual void DispatchingModuleInterface::RestartTimer ( DS_Event & event )

virtual

Method ask to restart timer of plugin, if plugin should restart it's timer on such event.

Parameters

event event generating restart timer request

Reimplemented in DS_Gps.

◆ SendString() [1/2]

virtual bool DispatchingModuleInterface::SendString	(	DS_Event &	event,
		ds_string &	sendString,
		bool &	forceImmediateSending
	)

pure virtual

Pure virtual method handles sending request. String is prepared (modified) by plugin depending on occured event and it's configuration. This method is implemented in ancestor.

Parameters

event	occurent event to be handled
sendString	modified string by plugin
forceImmediateSending	plugin can set this to true to ensure immediate sending message to dispatching

Returns: true when all went OK, false otherwise.

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

Here is the caller graph for this function:

◆ SendString() [2/2]

virtual bool DispatchingModuleInterface::SendString	(	DS_Event &	event,
		ds_string &	sendString,
		bool &	forceImmediateSending
	)

pure virtual

Pure virtual method handles sending request. String is prepared (modified) by plugin depending on occured event and it's configuration. This method is implemented in ancestor.

Parameters

event	occurent event to be handled
sendString	modified string by plugin
forceImmediateSending	plugin can set this to true to ensure immediate sending message to dispatching

Returns: true when all went OK, false otherwise.

Implemented in DS_CAN_Value, DS_Delays, DS_Distance, DS_Events, DS_Gps, DS_Messages, DS_Monitoring, DS_Passengers, DS_Reservation, and DS_System.

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

src/appcore/appcore/dispatching/DispatchingModuleInterface.h
src/appcore/dispatching/DispatchingModuleInterface.h
src/appcore/dispatching/DispatchingModuleInterface.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DispatchingModuleInterface() [1/2]

◆ ~DispatchingModuleInterface() [1/2]

◆ DispatchingModuleInterface() [2/2]

◆ ~DispatchingModuleInterface() [2/2]

Member Function Documentation

◆ Disable() [1/2]

◆ Disable() [2/2]

◆ Enable() [1/2]

◆ Enable() [2/2]

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetVersion() [1/2]

◆ GetVersion() [2/2]

◆ Init() [1/2]

◆ Init() [2/2]

◆ IsEnabled() [1/2]

◆ IsEnabled() [2/2]

◆ PostSendString() [1/2]

◆ PostSendString() [2/2]

◆ RestartTimer() [1/2]

◆ RestartTimer() [2/2]

◆ SendString() [1/2]

◆ SendString() [2/2]