Critical Link MityCam SoC Firmware  1.0
Critical Link MityCam SoC Firmware
SocCamera::tcConsoleInterface Class Reference

#include <ConsoleInterface.h>

Inheritance diagram for SocCamera::tcConsoleInterface:
Collaboration diagram for SocCamera::tcConsoleInterface:

Public Member Functions

 tcConsoleInterface (tcIOChannel *apChannel, tcSensorBoard *apSensor)
 
virtual ~tcConsoleInterface ()
 
virtual void onFileWritten (int32 anNumWritten)
 
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)
 
- Public Member Functions inherited from SocCamera::tcCommandInterface
 tcCommandInterface (const char *ifacename, tcSensorBoard *apSensor, tcIOChannel *apChannel)
 
virtual ~tcCommandInterface ()
 Destructor. More...
 
void initializeCommandHandlers ()
 
virtual void * run ()
 
virtual void addTEC (tcPIDControl *apPID)
 
tcAbstractHandlergetChain (void)
 
tcAbstractHandlergetHandler (std::string name)
 
- Public Member Functions inherited from tcThread
 tcThread ()
 
virtual ~tcThread ()
 
void join ()
 
virtual void start ()
 
virtual void stop ()
 

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
 
tcSensorBoardmpSensor
 
tcIOChannelmpChannel
 
- Protected Attributes inherited from tcThread
bool mbKillThread
 
- Static Protected Attributes inherited from SocCamera::tcCommandInterface
static tcAbstractHandlergpChainHead = NULL
 
static tcAbstractHandlergpChainTail = NULL
 
static std::map< std::string, tcAbstractHandler * > mcStringMap
 
static tcMutex chain_initializer = tcMutex()
 

Constructor & Destructor Documentation

◆ tcConsoleInterface()

tcConsoleInterface::tcConsoleInterface ( tcIOChannel apChannel,
tcSensorBoard apSensor 
)

◆ ~tcConsoleInterface()

tcConsoleInterface::~tcConsoleInterface ( )
virtual

Member Function Documentation

◆ finish()

void tcConsoleInterface::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 tcConsoleInterface::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.

◆ onFileWritten()

void SocCamera::tcConsoleInterface::onFileWritten ( int32  anNumWritten)
virtual

Reimplemented from tcFilesystemIOWatcher.

◆ parseInput()

string tcConsoleInterface::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 tcConsoleInterface::respond ( std::string  anResponse)
virtual

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

Parameters
anResponse- the return code from parseInput()

Implements SocCamera::tcCommandInterface.


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