SimcamManager Class Reference
[Pipeline element 1: Camera.]

class SimcamManager: A simulated camera for debugging and testing the PVClib architecture. More...

#include <simcam.h>

Inheritance diagram for SimcamManager:

SourcePipelinePlugin< unsigned char * > FrameProducer< unsigned char * > List of all members.

Public Member Functions

 SimcamManager (int width, int height, int patWidth, int patHeight, int patBPP, int patOfsX, int patOfsY, const char *patFile)
 Constructor.
virtual ~SimcamManager ()
 Destructor.
int userFunction (const char *functionTitle,...)
 overloaded userFunction.

Protected Member Functions

void mainFrame (unsigned char *&outFrame)
 The main processing loop.

Detailed Description

class SimcamManager: A simulated camera for debugging and testing the PVClib architecture.


Constructor & Destructor Documentation

SimcamManager::SimcamManager int  width,
int  height,
int  patWidth,
int  patHeight,
int  patBPP,
int  patOfsX,
int  patOfsY,
const char *  patFile
 

Constructor.

Parameters:
[in] width the width of the image buffer.
[in] height the height of the image buffer.
[in] patWidth the width of the pattern image that will be used to simulate a device.
[in] patHeight the height of the pattern image.
[in] patBPP bits per pixel in the pattern image.
[in] patOfsX x offset from the origin of the pattern to the center of the pattern.
[in] patOfsY y offset from the origin of the pattern to the center of the pattern.
[in] patFile name of the pattern image file.


Member Function Documentation

void SimcamManager::mainFrame unsigned char *&  outFrame  )  [protected, virtual]
 

The main processing loop.

Called by superclass SourcePipelinePlugin during the onTimer() function.

Parameters:
[out] outFrame A pointer to a frame of simulated output generated by the simcam. The associated data buffer is allocated and maintained internally.

Implements SourcePipelinePlugin< unsigned char * >.

int SimcamManager::userFunction const char *  functionTitle,
  ...
 

overloaded userFunction.

Parameters:
[in] functionTitle used to select a user function. Descriptions of each function with parameter lists follows: functionTitle: "SetXY" argument 1: int X argument 2: int Y action: sets the patternX and patternY internal variables which are used to locate the pattern in the framebuffer returns: always 1. If incorrect arguments are specified, behavior of this function is unknown. (by the author anyway)


The documentation for this class was generated from the following file:
Generated on Wed Mar 15 08:01:32 2006 for pvclib by  doxygen 1.4.6-NO