SocCamera::tcFrameIntervalHandler Class Reference

#include <FrameIntervalHandler.h>

Inheritance diagram for SocCamera::tcFrameIntervalHandler:

Collaboration diagram for SocCamera::tcFrameIntervalHandler:

Public Types
enum	teInterval { eeSetInterval, eeGetInterval, eeGetMinInterval }

Public Member Functions
	tcFrameIntervalHandler (tcSensorBoard *apSensor, tcAbstractHandler *apNextHandler=NULL, std::map< std::string, tcAbstractHandler * > *apMap=NULL)
void	update (tsUpdate asMessage)
virtual std::string	execute (std::string &arCommandString, std::string &arParameters)
teNackCode	execute (teInterval aeType, int32 &arInterval)
virtual void	notifyRead (int64_t anAddr, int64_t anOffset, int64_t anLen) const override
	notifyRead - a pre-read notification hook More...
Public Member Functions inherited from SocCamera::tcAbstractHandler
	tcAbstractHandler (tcSensorBoard *apSensor, tcAbstractHandler *apNextHandler=NULL)
virtual	~tcAbstractHandler ()
void	appendHandler (tcAbstractHandler *apNextHandler)
tcAbstractHandler *	prependHandler (tcAbstractHandler *apFirstHandler)
virtual void	SetIOChannel (tcIOChannel *apChannel)
void	unregisterFromFile ()
const std::string &	name () const
	return the handler name More...
Public Member Functions inherited from tcObserver
	tcObserver ()
virtual	~tcObserver ()

Additional Inherited Members
Protected Member Functions inherited from SocCamera::tcAbstractHandler
void	Report (const char *fmt,...)
void	ReportError (const char *fmt,...)
Static Protected Member Functions inherited from SocCamera::tcAbstractHandler
static std::string	nack (int32 anNack)
static std::string	ack (std::string *apValue=NULL)
static std::string	carrotNumber (float anNum)
static std::string	carrotNumber (int32 anNum)
static std::string	carrotNumberHex (int32 anNum)
static void	handleCode (tcRegUpdateUint32Msg *apMsg, teNackCode anCode)
Protected Attributes inherited from SocCamera::tcAbstractHandler
std::string	m_name
tcAbstractHandler *	mpNextHandler
tcSensorBoard *	mpSensor

Member Enumeration Documentation

teInterval

enum SocCamera::tcFrameIntervalHandler::teInterval

Enumerator
eeSetInterval
eeGetInterval
eeGetMinInterval

Constructor & Destructor Documentation

tcFrameIntervalHandler()

tcFrameIntervalHandler::tcFrameIntervalHandler	(	tcSensorBoard *	apSensor,
		tcAbstractHandler *	apNextHandler = NULL,
		std::map< std::string, tcAbstractHandler * > *	apMap = NULL
	)

Member Function Documentation

execute() [1/2]

std::string tcFrameIntervalHandler::execute ( std::string &  arCommandString, std::string &  arParameters  )

virtual

Call this to launch the chain. Iterates over the handlers until one succeeds or runs out of handlers.

Parameters

arCommandString	- the command that was found.
arParameters	- the string of parameters that must be processed.

Returns

the response to write out the command interface

Reimplemented from SocCamera::tcAbstractHandler.

execute() [2/2]

teNackCode tcFrameIntervalHandler::execute	(	tcFrameIntervalHandler::teInterval	aeType,
		int32 &	arInterval
	)

notifyRead()

void tcFrameIntervalHandler::notifyRead ( int64_t  anAddr, int64_t  anOffset, int64_t  anLen  ) const

overridevirtual

notifyRead - a pre-read notification hook

Parameters

anAddr	base address of GenICam Register in question about to be read
anOffset	offset into the GenICam Register region about to be read
anLen	number of bytes about to be read

Implements tcRegisterFileObserver.

update()

void tcFrameIntervalHandler::update ( tsUpdate  asMessage )

virtual

Observers are updated of a change by an observable.

Parameters

asMessage

- the message sent by the observable.

Reimplemented from SocCamera::tcAbstractHandler.

---

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

• /tmp/mitycam_sdk/ARM/camera_software/src/CommandHandlers/FrameIntervalHandler.h
• /tmp/mitycam_sdk/ARM/camera_software/src/CommandHandlers/FrameIntervalHandler.cpp