sbss::fgf::dvc::CommAdapter Class Reference

FrameGrabber Communication Adapter. More...

#include <commAdapter.hpp>

Inheritance diagram for sbss::fgf::dvc::CommAdapter:

Public Member Functions
	CommAdapter (ifw::fgf::common::RtmsPublisher &publisher, const std::string &filename)
virtual	~CommAdapter ()
virtual void	Initialise ()
	Initialise camera SDK.
virtual void	CheckConnection (bool &connected)
	CheckConnection.
virtual void	Connect ()
	Connect to camera.
virtual void	Disconnect ()
	Disconnect from the camera.
virtual bool	IsConnected () const
	IsConnected.
virtual void	Read (ifw::fgf::common::VectorVariant &params) const override
	Read a generic set of attributes.
virtual void	Read (ifw::fgf::common::PairVariant &param) const override
	Read a single attribute.
virtual void	Write (const ifw::fgf::common::VectorVariant &params) override
	Write a set of attributes.
virtual void	Write (const ifw::fgf::common::PairVariant &param) override
	Write a single attribute.
virtual short	Setup () override
	Setup image acquisition.
virtual short	Start () override
	Start image acquisition.
virtual short	Stop () override
	Stop image acquisition.
virtual short	Reset () override
	Reset frame grabber.
virtual std::string	GetLoggers () override
	Return the set of (log4cplus) loggers currently in use.
virtual short	SetLogLevel (std::string &level, std::string &logger) override
	Set the logging level for a (log4cplus) logger.
void	WaitForEmptyQueue (const int timeout_ms) const
Public Member Functions inherited from ifw::fgf::common::ICommAdapter
virtual	~ICommAdapter ()

Protected Attributes
std::shared_ptr< ifw::fgf::common::RawImage >	m_raw_image
int	m_img_bpp {0}
int	m_img_width {0}
int	m_img_height {0}

Detailed Description

FrameGrabber Communication Adapter.

Constructor & Destructor Documentation

CommAdapter()

sbss::fgf::dvc::CommAdapter::CommAdapter	(	ifw::fgf::common::RtmsPublisher &	publisher,
		const std::string &	filename )

~CommAdapter()

sbss::fgf::dvc::CommAdapter::~CommAdapter ( )

virtual

Member Function Documentation

CheckConnection()

void sbss::fgf::dvc::CommAdapter::CheckConnection ( bool & connected )

virtual

CheckConnection.

Connect()

void sbss::fgf::dvc::CommAdapter::Connect ( )

virtual

Connect to camera.

Disconnect()

void sbss::fgf::dvc::CommAdapter::Disconnect ( )

virtual

Disconnect from the camera.

GetLoggers()

std::string sbss::fgf::dvc::CommAdapter::GetLoggers ( )

overridevirtual

Return the set of (log4cplus) loggers currently in use.

Implements ifw::fgf::common::ICommAdapter.

Initialise()

void sbss::fgf::dvc::CommAdapter::Initialise ( )

virtual

Initialise camera SDK.

IsConnected()

bool sbss::fgf::dvc::CommAdapter::IsConnected ( ) const

virtual

IsConnected.

Read() [1/2]

void sbss::fgf::dvc::CommAdapter::Read ( ifw::fgf::common::PairVariant & param ) const

overridevirtual

Read a single attribute.

Implements ifw::fgf::common::ICommAdapter.

Read() [2/2]

void sbss::fgf::dvc::CommAdapter::Read ( ifw::fgf::common::VectorVariant & params ) const

overridevirtual

Read a generic set of attributes.

Implements ifw::fgf::common::ICommAdapter.

Reset()

short sbss::fgf::dvc::CommAdapter::Reset ( )

overridevirtual

Reset frame grabber.

Implements ifw::fgf::common::ICommAdapter.

SetLogLevel()

short sbss::fgf::dvc::CommAdapter::SetLogLevel ( std::string & level, std::string & logger )

overridevirtual

Set the logging level for a (log4cplus) logger.

Implements ifw::fgf::common::ICommAdapter.

Setup()

short sbss::fgf::dvc::CommAdapter::Setup ( )

overridevirtual

Setup image acquisition.

Implements ifw::fgf::common::ICommAdapter.

Start()

short sbss::fgf::dvc::CommAdapter::Start ( )

overridevirtual

Start image acquisition.

Implements ifw::fgf::common::ICommAdapter.

Stop()

short sbss::fgf::dvc::CommAdapter::Stop ( )

overridevirtual

Stop image acquisition.

Implements ifw::fgf::common::ICommAdapter.

WaitForEmptyQueue()

void sbss::fgf::dvc::CommAdapter::WaitForEmptyQueue

(

const int

timeout_ms

)

const

Write() [1/2]

void sbss::fgf::dvc::CommAdapter::Write ( const ifw::fgf::common::PairVariant & param )

overridevirtual

Write a single attribute.

Implements ifw::fgf::common::ICommAdapter.

Write() [2/2]

void sbss::fgf::dvc::CommAdapter::Write ( const ifw::fgf::common::VectorVariant & params )

overridevirtual

Write a set of attributes.

Implements ifw::fgf::common::ICommAdapter.

Member Data Documentation

m_img_bpp

int sbss::fgf::dvc::CommAdapter::m_img_bpp {0}

protected

m_img_height

int sbss::fgf::dvc::CommAdapter::m_img_height {0}

protected

m_img_width

int sbss::fgf::dvc::CommAdapter::m_img_width {0}

protected

m_raw_image

std::shared_ptr<ifw::fgf::common::RawImage> sbss::fgf::dvc::CommAdapter::m_raw_image

protected

---

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

• fgf/template/fgf-dvc/adapter/src/include/sbss/fgf/dvc/commAdapter.hpp
• fgf/template/fgf-dvc/adapter/src/commAdaptor.cpp