SocCamera Namespace Reference

Classes
class	ROI
class	tcAbstractHandler
class	tcBadPixelHandler
class	tcBinningHandler
class	tcBlackLevelEstimator
class	tcBlackLevelHandler
class	tcBPPModeHandler
class	tcBufferedCameraLinkIO
class	tcBufferedCameraLinkWatcher
class	tcBufferedCLHandler
class	tcCalibrationHandler
class	tcCameraLinkSerial
class	tcCamlinkPixClockHandler
class	tcClockHandler
class	tcCommandInterface
class	tcConsoleInterface
class	tcControlApplication
class	tcDigitalIOHandler
class	tcDspParserBase
class	tcEdgeDetectionHandler
class	tcEdgeDetectionReceiver
class	tcExposureHandler
class	tcExternalExposure
class	tcFanHandler
class	tcFilesystemHandler
class	tcFlipXHandler
class	tcFrameIntervalHandler
class	tcFrameSubtract
class	tcGainControl
class	tcGainHandler
class	tcGainModeHandler
class	tcGainModeReceiver
class	tcGigEInterface
class	tcGigEIO
	The GigE streaming IO channel interface. More...
class	tcGigEIOHandler
class	tcIndicatorHandler
class	tcLegacyCCD
	The tcLegacyCCD class provides interfaces needed to control CCDs and support the MityViewer interface. More...
class	tcMityViewerInterface
class	tcMultipleROIHandler
class	tcMultipleROISensor
class	tcNamedPipeInterface
class	tcNoiseReductionHandler
class	tcOutputModeHandler
class	tcPeekHandler
class	tcPendingAckWatchdog
class	tcPendingAckWatcher
class	tcPIDControl
class	tcPinHandler
class	tcPixelBinner
class	tcPokeHandler
class	tcPowerHandler
class	tcQueueIO
class	tcQueueWatcher
class	tcRecallConfHandler
class	tcRegisterFile
class	tcRegUpdateMsg
class	tcRegUpdateTypeMsg
class	tcResetHandler
class	tcROIHandler
class	tcSavableSensorBoard
class	tcSaveConfHandler
class	tcSensorBoard
class	tcShutterModeHandler
class	tcSimSensorSensorBoard
	The tcSimSensorSensorBoard class. SimSensor Main class manager for a given sensor board. More...
class	tcSqrtHandler
class	tcStartStopHandler
class	tcStdOutSensorBoard
class	tcTDIHandler
class	tcTECHandler
class	tcTemperatureHandler
class	tcTemperatureSensor
class	tcTestPatternHandler
class	tcTestPendingAckHandler
class	tcTimeStampHandler
class	tcTriggerHandler
class	tcU3VDelegate
class	tcU3VHandler
class	tcU3VIO
class	tcU3VisionInterface
class	tcUserNameHandler
class	tcVariableHandler
class	tcVersionHandler
class	tcVoltageSensor
class	tcVoltageSensorHandler
struct	tsCameraInfo

Typedefs
typedef struct SocCamera::tsCameraInfo	tsCameraInfo
typedef tcRegUpdateTypeMsg< uint64_t >	tcRegUpdateUint64Msg
typedef tcRegUpdateTypeMsg< uint32_t >	tcRegUpdateUint32Msg
typedef tcRegUpdateTypeMsg< float >	tcRegUpdateFloatMsg
typedef tcRegUpdateTypeMsg< std::string >	tcRegUpdateStringMsg
typedef tcRegUpdateTypeMsg< void * >	tcRegUpdateBufferMsg
typedef void(tcU3VDelegate::*	delFunc) (tsU3VMsg *apMsg)

Enumerations
enum	teCommandInterfaces {   eeINTERFACE_CAMERA_LINK = 0, eeINTERFACE_CONSOLE = 1, eeINTERFACE_MITY_VIEWER = 2, eeINTERFACE_NAMED_PIPE = 3,   eeINTERFACE_GIGE = 4, eeINTERFACE_U3V = 5, eeINTERFACE_SKIP_HDMI = 6, eeINTERFACE_CXP = 7 }
enum	teStatusInterfaces { eeSTATUS_PCA9553 = 0, eeSTATUS_CONSOLE = 1, eeSTATUS_GENICAM = 2 }
enum	teIOChannels {   eeIO_CAMERA_LINK = 0, eeIO_FILESYSTEM = 1, eeIO_BUFFERED_CAMERA_LINK = 2, eeIO_GIGE = 3,   eeIO_U3V = 5, eeIO_HDMI = 6, eeIO_HDMI_1411PEK = 7, eeIO_CXP = 8,   eeIO_MEMORY = 9, eeIO_MITYVIEWER = 10000 }
enum	teNackCode {   eeNoError = 0, eeUnrecognizedCommand = 1, eeArgumentMissing = 2, eeArgumentOutOfRange = 3,   eeInvalidConfiguration = 4, eeCaptureInProgress = 5, eeCameraNotResponding = 6, eeOperationNotSupported = 7,   eeIndexMismatch = 8 }
enum	teTriggerMode {   eeSoftware = 0, eeCamIO0 = 1, eeCamIO1 = 2, eeCamIO2 = 3,   eeCamIO3 = 4 }
enum	teTestPattern {   eeNoTestPattern = 0, eeSensorGradiantPattern = 1, eeDigitalPatternGradX = 16, eeDigitalPatternGradY = 17,   eeDigitalPatternNibs = 18, eeDigitalPatternGrid = 19 }
enum	teBPPMode { ee8bpp = 0, ee16bpp = 1, ee12bpp = 2, ee12bpp_packed = 3 }
enum	teShutterMode { eeRollingShutter = 0, eeGlobalShutter = 1 }
enum	teRegType {   eeRegNoType, eeRegUint32, eeRegFloat, eeRegUint64,   eeRegString }
	Specifies what kind of data a register holds. More...

Functions
const char *	errorString (const teNackCode aeCode)

Detailed Description

TemperatureSensor.h

VoltageSensor.h

We typically wrap the tcSensorBoard implementation under the SocCamera Namespace

Typedef Documentation

delFunc

typedef void(tcU3VDelegate::* SocCamera::delFunc) (tsU3VMsg *apMsg)

tcRegUpdateBufferMsg

typedef tcRegUpdateTypeMsg<void *> SocCamera::tcRegUpdateBufferMsg

This is the class which is passed to command handlers via the observer update callbacks when an raw buffer register is updated. Via the members here the command handlers can see the old value of the register and the new value. They can also modify the value that will be written to the register via the m_fixval member. When the observer callbacks are invoked the register file still contains the old value. When the observer callbacks are begun the new value and the fix value are the same. If some handler wants to range adjust or fix readonly bits in the register it may modify the fix value. Upon return from the callbacks the fix value will be stored into the register file.

tcRegUpdateFloatMsg

typedef tcRegUpdateTypeMsg<float> SocCamera::tcRegUpdateFloatMsg

This is the class which is passed to command handlers via the observer update callbacks when an integer register file is updated. Via the members here the command handlers can see the old value of the register and the new value. They can also modify the value that will be written to the register via the m_fixval member. When the observer callbacks are invoked the register file still contains the old value. When the observer callbacks are begun the new value and the fix value are the same. If some handler wants to range adjust or fix readonly bits in the register it may modify the fix value. Upon return from the callbacks the fix value will be stored into the register file.

tcRegUpdateStringMsg

typedef tcRegUpdateTypeMsg<std::string> SocCamera::tcRegUpdateStringMsg

This is the class which is passed to command handlers via the observer update callbacks when an integer register file is updated. Via the members here the command handlers can see the old value of the register and the new value. They can also modify the value that will be written to the register via the m_fixval member. When the observer callbacks are invoked the register file still contains the old value. When the observer callbacks are begun the new value and the fix value are the same. If some handler wants to range adjust or fix readonly bits in the register it may modify the fix value. Upon return from the callbacks the fix value will be stored into the register file.

tcRegUpdateUint32Msg

typedef tcRegUpdateTypeMsg<uint32_t> SocCamera::tcRegUpdateUint32Msg

This is the class which is passed to command handlers via the observer update callbacks when an integer register file is updated. Via the members here the command handlers can see the old value of the register and the new value. They can also modify the value that will be written to the register via the m_fixval member. When the observer callbacks are invoked the register file still contains the old value. When the observer callbacks are begun the new value and the fix value are the same. If some handler wants to range adjust or fix readonly bits in the register it may modify the fix value. Upon return from the callbacks the fix value will be stored into the register file.

tcRegUpdateUint64Msg

typedef tcRegUpdateTypeMsg<uint64_t> SocCamera::tcRegUpdateUint64Msg

tsCameraInfo

typedef struct SocCamera::tsCameraInfo SocCamera::tsCameraInfo

Note

The sensor ID numbers refer to the SENSOR line in the config file. It is the value returned by the plugin's int sensorType() method. The allowed values are described in Sensors/README.txt

Enumeration Type Documentation

teBPPMode

enum SocCamera::teBPPMode

Enumerator
ee8bpp
ee16bpp
ee12bpp
ee12bpp_packed

teCommandInterfaces

enum SocCamera::teCommandInterfaces

Enumerator
eeINTERFACE_CAMERA_LINK
eeINTERFACE_CONSOLE
eeINTERFACE_MITY_VIEWER
eeINTERFACE_NAMED_PIPE
eeINTERFACE_GIGE
eeINTERFACE_U3V
eeINTERFACE_SKIP_HDMI
eeINTERFACE_CXP

teIOChannels

enum SocCamera::teIOChannels

Enumerator
eeIO_CAMERA_LINK
eeIO_FILESYSTEM
eeIO_BUFFERED_CAMERA_LINK
eeIO_GIGE
eeIO_U3V
eeIO_HDMI
eeIO_HDMI_1411PEK
eeIO_CXP
eeIO_MEMORY
eeIO_MITYVIEWER

teNackCode

enum SocCamera::teNackCode

Enumerator
eeNoError
eeUnrecognizedCommand	!< No error
eeArgumentMissing	!< No command handler exists for command
eeArgumentOutOfRange	!< Command arguments missing
eeInvalidConfiguration	!< Argument out of range
eeCaptureInProgress	!< Internal configuration error... typically an incorrect sensor/handler combination
eeCameraNotResponding	!< Camera is busy capturing and action is not valid during capture
eeOperationNotSupported	!< Indicates a communication error (typically with the sensor)
eeIndexMismatch	!< Attempt to perform an operation that is not supported by the camera configuration

teRegType

enum SocCamera::teRegType

Specifies what kind of data a register holds.

Enumerator
eeRegNoType	Generic Register interface (an array of Binary Data)
eeRegUint32	Generic 32-bit unsigned integer interface (for endian management)
eeRegFloat	Single precision interface.
eeRegUint64	Generic 64-bit unsigned integer interface (for endian management)
eeRegString	A string interface (for variable size / null termination)

teShutterMode

enum SocCamera::teShutterMode

Enumerator
eeRollingShutter
eeGlobalShutter

teStatusInterfaces

enum SocCamera::teStatusInterfaces

Enumerator
eeSTATUS_PCA9553
eeSTATUS_CONSOLE
eeSTATUS_GENICAM

teTestPattern

enum SocCamera::teTestPattern

Enumerator
eeNoTestPattern
eeSensorGradiantPattern
eeDigitalPatternGradX	middle codes reserved for other sensor options
eeDigitalPatternGradY
eeDigitalPatternNibs
eeDigitalPatternGrid

teTriggerMode

enum SocCamera::teTriggerMode

Enumerator
eeSoftware
eeCamIO0
eeCamIO1
eeCamIO2
eeCamIO3

Function Documentation

errorString()

const char* SocCamera::errorString ( const teNackCode  aeCode )

inline