AcquisitionCameraModule Class Reference

The AcquisitionCameraModule class is a module designed to be in charge of frame acquisition from a live camera with video streaming. This module is adapted for local cameras and remote cameras using rtsp protocol for this last type of cameras. More...

#include <AcquisitionCameraModule.h>

Inheritance diagram for AcquisitionCameraModule:

Public Member Functions
	AcquisitionCameraModule (Datapool *i_data)
bool	setParameters (QDomNode &config)
bool	init ()
bool	run ()
bool	updateParameters ()
QImage *	Mat2QImage (cv::Mat &img)
TimeStamp	mseconds2TimeStamp (int msec)
	AcquisitionCameraModule (Datapool *i_data)
	Constructor. More...
bool	setParameters (QDomNode &config)
	Reads parameters from configuration file. More...
bool	init ()
	Initialization of module routine. More...
bool	run ()
	Executation of module routine. This is the life cycle of this module. More...
bool	updateParameters ()
	Updates module parameters when modified by user at executation time. More...
QImage *	Mat2QImage (cv::Mat &img)
	Transform cv::Mat format image into QImage format image. More...
TimeStamp	mseconds2TimeStamp (int msec)
	Transforms miliseconds to TimeStamp format used in system. More...
Public Member Functions inherited from ModuleInterface
	ModuleInterface (Datapool *i_data)
void	addParameter (QString name, QString value, QString type)
void	addParameterChild (QString name, QString value, QString type, parameter *parent)
parameter *	getParameter (QString name)
parameter *	getParameter (QString name, parameter *parent)
parameter *	getParameter (QString name, std::multimap< QString, parameter > subList)
Parameter2 *	getParameterFromTree (const QString name)
Parameter2 *	getParameterFromTree (const QString name, Parameter2 *parent)
Parameter2 *	getParameterFromTree (const QString name, std::multimap< QString, Parameter2 > subList)
void	addParameterToTree (const QString name, const QString value, const QString defaultValue, const ParameterDataType &type)
void	addChildParameterToTree (const QString &name, const QString &value, const QString &defaultValue, const ParameterDataType &type, Parameter2 *parent)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const bool &defaulValue, bool &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const char &defaulValue, char &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const uchar &defaulValue, uchar &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const int &defaulValue, int &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const uint &defaulValue, uint &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const long &defaulValue, long &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const ulong &defaulValue, ulong &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const float &defaulValue, float &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const double &defaulValue, double &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const QString &defaulValue, QString &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const bool defaulValue, bool &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const int defaulValue, int &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const char defaulValue, char &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const uchar defaulValue, uchar &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const uint defaulValue, uint &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const long defaulValue, long &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const ulong defaulValue, ulong &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const float defaulValue, float &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const double defaulValue, double &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const QString defaulValue, QString &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const bool defaulValue, bool &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const int defaulValue, int &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const char defaulValue, char &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const uchar defaulValue, uchar &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const uint defaulValue, uint &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const long defaulValue, long &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const ulong defaulValue, ulong &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const float defaulValue, float &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const double defaulValue, double &outParameter, QDomNode &parameterNode, bool appendWarning=false)
bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const QString defaulValue, QString &outParameter, QDomNode &parameterNode, bool appendWarning=false)

Additional Inherited Members
Public Attributes inherited from ModuleInterface
std::deque< QString >	nameParameters
std::deque< QString >	valueParameters
std::deque< QString >	typeParameters
std::deque< parameter >	listParameters
std::deque< Parameter2 >	parametersTree
std::string	name
ModuleType	type
Protected Attributes inherited from ModuleInterface
Datapool *	m_data

Detailed Description

The AcquisitionCameraModule class is a module designed to be in charge of frame acquisition from a live camera with video streaming. This module is adapted for local cameras and remote cameras using rtsp protocol for this last type of cameras.

AcquisitionCameraModule

Constructor & Destructor Documentation

AcquisitionCameraModule::AcquisitionCameraModule

(

Datapool *

i_data

)

Constructor.

Parameters

i_data

This param is a reference to common data pool in the whole application.

Member Function Documentation

bool AcquisitionCameraModule::init ( )

virtual

Initialization of module routine.

Returns

True if success.

Implements ModuleInterface.

QImage* AcquisitionCameraModule::Mat2QImage

(

cv::Mat &

img

)

Transform cv::Mat format image into QImage format image.

Parameters

img	Image of cv::Mat format.

Returns

Image of QImage format.

TimeStamp AcquisitionCameraModule::mseconds2TimeStamp

(

int

msec

)

Transforms miliseconds to TimeStamp format used in system.

Parameters

msec	miliseconds.

Returns

time in TimeStamp format.

bool AcquisitionCameraModule::run ( )

virtual

Executation of module routine. This is the life cycle of this module.

Returns

True if success.

Implements ModuleInterface.

bool AcquisitionCameraModule::setParameters ( QDomNode &  config )

virtual

Reads parameters from configuration file.

Parameters

config

Configuration xml node that correspond to this module

Returns

True if success.

Implements ModuleInterface.

bool AcquisitionCameraModule::updateParameters ( )

virtual

Updates module parameters when modified by user at executation time.

Returns

True if success.

Implements ModuleInterface.

---

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

• MODULES/Acquisition/AcquisitionCameraModule.h
• MODULES/Acquisition/AcquisitionCameraModule.cpp