Critical Link MityCam SoC Firmware  1.0
Critical Link MityCam SoC Firmware
Public Member Functions | Friends | List of all members
SocCamera::tcU3VisionInterface Class Reference

#include <U3VisionInterface.h>

Inheritance diagram for SocCamera::tcU3VisionInterface:
Collaboration diagram for SocCamera::tcU3VisionInterface:

Public Member Functions

 tcU3VisionInterface (tcIOChannel *apChannel, tcSensorBoard *apSensor, std::string *apData)
 
virtual ~tcU3VisionInterface ()
 
virtual void * run ()
 
virtual void getInput (std::string *apStringOutput)
 
virtual std::string parseInput (std::string &arStringToParse)
 
virtual void respond (std::string anResponse)
 
virtual void finish (std::string &arOriginalBuffer)
 
virtual void update_payload_size (const uint32_t payload_size)
 
void update (tsUpdate anMsg)
 
- Public Member Functions inherited from SocCamera::tcCommandInterface
 tcCommandInterface (const char *ifacename, tcSensorBoard *apSensor, tcIOChannel *apChannel)
 
virtual ~tcCommandInterface ()
 Destructor. More...
 
void initializeCommandHandlers ()
 
virtual void addTEC (tcPIDControl *apPID)
 
tcAbstractHandler * getChain (void)
 
tcAbstractHandler * getHandler (std::string name)
 
- Public Member Functions inherited from tcThread
 tcThread ()
 
virtual ~tcThread ()
 
void join ()
 
virtual void start ()
 
virtual void stop ()
 
- Public Member Functions inherited from tcPayloadSetter
 tcPayloadSetter ()
 
virtual ~tcPayloadSetter ()
 
- Public Member Functions inherited from tcObserver
 tcObserver ()
 
virtual ~tcObserver ()
 

Friends

class tcU3VDelegate
 

Additional Inherited Members

- Static Public Member Functions inherited from SocCamera::tcCommandInterface
static std::string registerName (uint32_t anReg)
 
- Static Public Attributes inherited from tcThread
static const int HIGHEST_PRIORITY = -2
 
static const int HIGH_PRIORITY = -1
 
static const int NORMAL_PRIORITY = 0
 
static const int LOW_PRIORITY = 1
 
static const int LOWEST_PRIORITY = 2
 
- Protected Member Functions inherited from SocCamera::tcCommandInterface
void Report (const char *fmt,...)
 This method routes text to stderr. More...
 
void ReportError (const char *fmt,...)
 
- Protected Member Functions inherited from tcThread
void setPriority (int anRelativePriority)
 
- Protected Attributes inherited from SocCamera::tcCommandInterface
std::string m_ifacename
 
tcSensorBoard * mpSensor
 
tcIOChannel * mpChannel
 
- Protected Attributes inherited from tcThread
bool mbKillThread
 
- Static Protected Attributes inherited from SocCamera::tcCommandInterface
static tcAbstractHandler * gpChainHead = NULL
 
static tcAbstractHandler * gpChainTail = NULL
 
static std::map< std::string, tcAbstractHandler * > mcStringMap
 
static tcMutex chain_initializer = tcMutex()
 

Constructor & Destructor Documentation

◆ tcU3VisionInterface()

tcU3VisionInterface::tcU3VisionInterface ( tcIOChannel *  apChannel,
tcSensorBoard *  apSensor,
std::string *  apData 
)

◆ ~tcU3VisionInterface()

tcU3VisionInterface::~tcU3VisionInterface ( )
virtual

Member Function Documentation

◆ finish()

void tcU3VisionInterface::finish ( std::string &  arOriginalBuffer)
virtual

Perform cleanup tasks. (eg: reboot, signal thread to die, etc).

Parameters
arOriginalBuffer- the original buffer that was gotten

Implements SocCamera::tcCommandInterface.

◆ getInput()

void tcU3VisionInterface::getInput ( std::string *  apStringOutput)
virtual

Gets the input from whatever means it has to and stores it in the std::string pointed to by the parameter.

Parameters
apStringOutput- pointer to the location to store the input

Implements SocCamera::tcCommandInterface.

◆ parseInput()

string tcU3VisionInterface::parseInput ( std::string &  arStringToParse)
virtual

Process the input string and call whatever functions are appropriate on the SensorBoard object.

Parameters
arStringOutput- the input string to process.
Returns
an int32 code corresponding to the success of processing.

Implements SocCamera::tcCommandInterface.

◆ respond()

void tcU3VisionInterface::respond ( std::string  anResponse)
virtual

Send the <ACK>, <NACK> based on the response input

Parameters
anResponse- the return code from parseInput()

Implements SocCamera::tcCommandInterface.

◆ run()

void * SocCamera::tcU3VisionInterface::run ( )
virtual

run() should spin getting input from getInput() and sends it to parseInput() for processing. This fully abstracts threading.

Returns
unused

Reimplemented from SocCamera::tcCommandInterface.

◆ update()

void SocCamera::tcU3VisionInterface::update ( tsUpdate  asMessage)
virtual

Observers are updated of a change by an observable.

Parameters
asMessage- the message sent by the observable.

Implements tcObserver.

◆ update_payload_size()

void SocCamera::tcU3VisionInterface::update_payload_size ( const uint32_t  payload_size)
virtual

Implements tcPayloadSetter.

Friends And Related Function Documentation

◆ tcU3VDelegate

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