#include <SIMRAMStreamer.h>

Inheritance diagram for tcSIMRAMStreamer:

Collaboration diagram for tcSIMRAMStreamer:

Public Member Functions
	tcSIMRAMStreamer ()

virtual	~tcSIMRAMStreamer ()

virtual bool	initialize () override

virtual void	reset (bool abReset) override

virtual void	setStartAddr (unsigned int anAddr) override

virtual void	setEndAddr (unsigned int anAddr) override

virtual void	setFrameSize (unsigned int anNumBytes) override

virtual void	setInterruptLevel (unsigned int anNumFrames) override

virtual unsigned int	getInterruptLevel () override

virtual void	setFramesToCapture (unsigned short anNumFrames) override

virtual void	clearInterrupt () override

virtual void	setInterruptEnable (bool abEnable) override

virtual bool	isReady () override

virtual void	setPacking (bool abEnable) override

virtual bool	isPacking () override

virtual void	setPackingMode (tePackingMode aeMode) override

virtual tePackingMode	getPackingMode () override

virtual uint32_t	getBufferSize (void)

virtual uint8_t *	getBuffer (void)

void *	allocBuffer (uint8_t *apBuffer, uint32_t anBlockSize, uint32_t anOffset)

void	tickFrameCtr (uint32_t cnt=1)

Public Member Functions inherited from tcRAMStreamer
	tcRAMStreamer (int anBaseAddress)

virtual	~tcRAMStreamer ()

virtual unsigned int	getStartAddr ()

virtual unsigned int	getEndAddr ()

virtual unsigned int	getFrameSize ()

virtual unsigned short	getFramesToCapture (void)
	getFramesToCapture More...

Protected Attributes
uint8_t *	mpBuffer

bool	mbPacking

tePackingMode	mePackingMode

uint32_t	mnOffset

uint32_t	mnBlocksize

uint32_t	mnInterruptLevel

uint32_t	mnFramesToCapture

bool	mbInterruptEnabled

uint32_t	mnFrameTotal

uint32_t	mnFrameInt

Protected Attributes inherited from tcRAMStreamer
uint32_t	mnNumBytes

uint32_t	mnStartAddr

uint32_t	mnEndAddr

Additional Inherited Members
Public Types inherited from tcRAMStreamer
enum	tePackingMode { eeMono16 = 0, eeMono12p = 1, eeMono8p = 2, eeMono12packed = 3 }

Constructor & Destructor Documentation

◆ tcSIMRAMStreamer()

tcSIMRAMStreamer::tcSIMRAMStreamer ( )

◆ ~tcSIMRAMStreamer()

tcSIMRAMStreamer::~tcSIMRAMStreamer ( )

virtual

Member Function Documentation

◆ allocBuffer()

void * tcSIMRAMStreamer::allocBuffer	(	uint8_t *	apBuffer,
		uint32_t	anBlockSize,
		uint32_t	anOffset
	)

◆ clearInterrupt()

void tcSIMRAMStreamer::clearInterrupt ( )

overridevirtual

Clears the Interrupt Status bit.

Reimplemented from tcRAMStreamer.

◆ getBuffer()

virtual uint8_t* tcSIMRAMStreamer::getBuffer ( void )

inlinevirtual

◆ getBufferSize()

virtual uint32_t tcSIMRAMStreamer::getBufferSize ( void )

inlinevirtual

end of tcRAMStreamer Overrides

◆ getInterruptLevel()

unsigned int tcSIMRAMStreamer::getInterruptLevel ( )

overridevirtual

Returns the currently set level of interrupt.

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

Reimplemented from tcRAMStreamer.

◆ getPackingMode()

virtual tePackingMode tcSIMRAMStreamer::getPackingMode ( )

inlineoverridevirtual

Reimplemented from tcRAMStreamer.

◆ initialize()

bool tcSIMRAMStreamer::initialize ( )

overridevirtual

tcRAMStreamer Overrides

Reimplemented from tcRAMStreamer.

◆ isPacking()

bool tcSIMRAMStreamer::isPacking ( )

overridevirtual

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

Returns: true if packing is turned on; false otherwise.

Reimplemented from tcRAMStreamer.

◆ isReady()

bool tcSIMRAMStreamer::isReady ( )

overridevirtual

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

Returns: true if the stream is complete. false otherwise.

Reimplemented from tcRAMStreamer.

◆ reset()

void tcSIMRAMStreamer::reset ( bool abReset )

overridevirtual

Set the reset bit.

Parameters

abReset - the state of the reset bit.

Reimplemented from tcRAMStreamer.

◆ setEndAddr()

void tcSIMRAMStreamer::setEndAddr ( unsigned int anAddr )

overridevirtual

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 from tcRAMStreamer.

◆ setFrameSize()

void tcSIMRAMStreamer::setFrameSize ( unsigned int anNumBytes )

overridevirtual

Sets the frame size register.

Parameters

anNumBytes - the number of bytes to set.

Reimplemented from tcRAMStreamer.

◆ setFramesToCapture()

void tcSIMRAMStreamer::setFramesToCapture ( unsigned short anNumFrames )

overridevirtual

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 from tcRAMStreamer.

◆ setInterruptEnable()

void tcSIMRAMStreamer::setInterruptEnable ( bool abEnable )

overridevirtual

Sets the state of the interrupt enable bit.

Parameters

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

Reimplemented from tcRAMStreamer.

◆ setInterruptLevel()

void tcSIMRAMStreamer::setInterruptLevel ( unsigned int anNumFrames )

overridevirtual

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

Reimplemented from tcRAMStreamer.

◆ setPacking()

void tcSIMRAMStreamer::setPacking ( bool abEnable )

overridevirtual

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

Reimplemented from tcRAMStreamer.

◆ setPackingMode()

virtual void tcSIMRAMStreamer::setPackingMode ( tePackingMode aeMode )

inlineoverridevirtual

Reimplemented from tcRAMStreamer.

◆ setStartAddr()

void tcSIMRAMStreamer::setStartAddr ( unsigned int anAddr )

overridevirtual

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 from tcRAMStreamer.

◆ tickFrameCtr()

void tcSIMRAMStreamer::tickFrameCtr ( uint32_t cnt = 1 )

Member Data Documentation

◆ mbInterruptEnabled

bool tcSIMRAMStreamer::mbInterruptEnabled

protected

◆ mbPacking

bool tcSIMRAMStreamer::mbPacking

protected

◆ mePackingMode

tePackingMode tcSIMRAMStreamer::mePackingMode

protected

◆ mnBlocksize

uint32_t tcSIMRAMStreamer::mnBlocksize

protected

◆ mnFrameInt

uint32_t tcSIMRAMStreamer::mnFrameInt

protected

◆ mnFramesToCapture

uint32_t tcSIMRAMStreamer::mnFramesToCapture

protected

◆ mnFrameTotal

uint32_t tcSIMRAMStreamer::mnFrameTotal

protected

◆ mnInterruptLevel

uint32_t tcSIMRAMStreamer::mnInterruptLevel

protected

◆ mnOffset

uint32_t tcSIMRAMStreamer::mnOffset

protected

◆ mpBuffer

uint8_t* tcSIMRAMStreamer::mpBuffer

protected

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

/tmp/mitycam_sdk/ARM/camera_software/src/Utility/SIMRAMStreamer.h
/tmp/mitycam_sdk/ARM/camera_software/src/Utility/SIMRAMStreamer.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ tcSIMRAMStreamer()

◆ ~tcSIMRAMStreamer()

Member Function Documentation

◆ allocBuffer()

◆ clearInterrupt()

◆ getBuffer()

◆ getBufferSize()

◆ getInterruptLevel()

◆ getPackingMode()

◆ initialize()

◆ isPacking()

◆ isReady()

◆ reset()

◆ setEndAddr()

◆ setFrameSize()

◆ setFramesToCapture()

◆ setInterruptEnable()

◆ setInterruptLevel()

◆ setPacking()

◆ setPackingMode()

◆ setStartAddr()

◆ tickFrameCtr()

Member Data Documentation

◆ mbInterruptEnabled

◆ mbPacking

◆ mePackingMode

◆ mnBlocksize

◆ mnFrameInt

◆ mnFramesToCapture

◆ mnFrameTotal

◆ mnInterruptLevel

◆ mnOffset

◆ mpBuffer