Critical Link MityCam SoC Firmware  1.0
Critical Link MityCam SoC Firmware
Public Types | Public Member Functions | Protected Attributes | List of all members
tcRAMStreamer Class Reference

#include <RAMStreamer.h>

Inheritance diagram for tcRAMStreamer:
Collaboration diagram for tcRAMStreamer:

Public Types

enum  tePackingMode { eeMono16 = 0, eeMono12p = 1, eeMono8p = 2, eeMono12packed = 3 }
 

Public Member Functions

 tcRAMStreamer (int anBaseAddress)
 
virtual ~tcRAMStreamer ()
 
virtual bool initialize ()
 
virtual void reset (bool abReset)
 
virtual void setStartAddr (unsigned int anAddr)
 
virtual unsigned int getStartAddr ()
 
virtual void setEndAddr (unsigned int anAddr)
 
virtual unsigned int getEndAddr ()
 
virtual void setFrameSize (unsigned int anNumBytes)
 
virtual unsigned int getFrameSize ()
 
virtual void setInterruptLevel (unsigned int anNumFrames)
 
virtual unsigned int getInterruptLevel ()
 
virtual void setFramesToCapture (unsigned short anNumFrames)
 
virtual unsigned short getFramesToCapture (void)
 getFramesToCapture More...
 
virtual void clearInterrupt ()
 
virtual void setInterruptEnable (bool abEnable)
 
virtual bool isReady ()
 
virtual void setPackingMode (tePackingMode aeMode)
 
virtual tePackingMode getPackingMode ()
 
virtual void setPacking (bool abEnable)
 
virtual bool isPacking ()
 

Protected Attributes

uint32_t mnNumBytes
 
uint32_t mnStartAddr
 
uint32_t mnEndAddr
 

Member Enumeration Documentation

◆ tePackingMode

enum tcRAMStreamer::tePackingMode
Enumerator
eeMono16 
eeMono12p 
eeMono8p 
eeMono12packed 

Constructor & Destructor Documentation

◆ tcRAMStreamer()

tcRAMStreamer::tcRAMStreamer ( int  anBaseAddress)

◆ ~tcRAMStreamer()

tcRAMStreamer::~tcRAMStreamer ( )
virtual

Member Function Documentation

◆ clearInterrupt()

void tcRAMStreamer::clearInterrupt ( )
virtual

Clears the Interrupt Status bit.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ getEndAddr()

unsigned int tcRAMStreamer::getEndAddr ( )
virtual

Returns the end address.

Returns
the end address.

Reimplemented in tcPCIEStreamer.

◆ getFrameSize()

unsigned int tcRAMStreamer::getFrameSize ( )
virtual

Returns the frame size in bytes.

Returns
the frame size

Reimplemented in tcPCIEStreamer.

◆ getFramesToCapture()

unsigned short tcRAMStreamer::getFramesToCapture ( void  )
virtual

getFramesToCapture

Returns
the number of images to capture; 0 for continuous

Reimplemented in tcPCIEStreamer.

◆ getInterruptLevel()

unsigned int tcRAMStreamer::getInterruptLevel ( )
virtual

Returns the currently set level of interrupt.

Returns
the number of frames to go before generating an interrupt.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ getPackingMode()

tcRAMStreamer::tePackingMode tcRAMStreamer::getPackingMode ( )
virtual

Reimplemented in tcSIMRAMStreamer, and tcPCIEStreamer.

◆ getStartAddr()

unsigned int tcRAMStreamer::getStartAddr ( )
virtual

Returns the start address.

Returns
the start address.

Reimplemented in tcPCIEStreamer.

◆ initialize()

bool tcRAMStreamer::initialize ( )
virtual
Returns
True if the register is initialized.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ isPacking()

bool tcRAMStreamer::isPacking ( )
virtual

DEPRECATED - use tePackingMode getPackingMode() instead. Returns if packing pixels is turned on.

Returns
true if packing is turned on; false otherwise.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ isReady()

bool tcRAMStreamer::isReady ( )
virtual

Tests whether the stream is complete by looking at the Interrupt Status bit.

Returns
true if the stream is complete. false otherwise.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ reset()

void tcRAMStreamer::reset ( bool  abReset)
virtual

Set the reset bit.

Parameters
abReset- the state of the reset bit.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setEndAddr()

void tcRAMStreamer::setEndAddr ( unsigned int  anAddr)
virtual

Set the end address of where to wrap around. This should be set by the IO Channel on a frame boundary.

Parameters
anAddr- the address to stream to.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setFrameSize()

void tcRAMStreamer::setFrameSize ( unsigned int  anNumBytes)
virtual

Sets the frame size register.

Parameters
anNumBytes- the number of bytes to set.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setFramesToCapture()

void tcRAMStreamer::setFramesToCapture ( unsigned short  anNumFrames)
virtual

Sets the number of images to capture; set to 0 for continuous capture.

Parameters
numCapture- the number of images to capture; 0 for continuous capture.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setInterruptEnable()

void tcRAMStreamer::setInterruptEnable ( bool  abEnable)
virtual

Sets the state of the interrupt enable bit.

Parameters
abEnable- true to enable interrupts; false to disable them.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setInterruptLevel()

void tcRAMStreamer::setInterruptLevel ( unsigned int  anNumFrames)
virtual

Sets the number of frames to be streamed to RAM before generating an interrupt.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setPacking()

void tcRAMStreamer::setPacking ( bool  abEnable)
virtual

DEPRECATED - use setPackingMode(tePackingMode) instead. Toggle to enable the packing of 12 bit pixels into 16 bit words.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

◆ setPackingMode()

void tcRAMStreamer::setPackingMode ( tePackingMode  aeMode)
virtual

Reimplemented in tcSIMRAMStreamer, and tcPCIEStreamer.

◆ setStartAddr()

void tcRAMStreamer::setStartAddr ( unsigned int  anAddr)
virtual

Set the start address of where to stream to. This should be set by the IO Channel.

Parameters
anAddr- the address to stream to.

Reimplemented in tcPCIEStreamer, and tcSIMRAMStreamer.

Member Data Documentation

◆ mnEndAddr

uint32_t tcRAMStreamer::mnEndAddr
protected

◆ mnNumBytes

uint32_t tcRAMStreamer::mnNumBytes
protected

◆ mnStartAddr

uint32_t tcRAMStreamer::mnStartAddr
protected
The documentation for this class was generated from the following files: