Vision::DFK51BG02H::GVCP Class Reference

Detailed Description

Implementation of the GigE Vision Control Protocol (GVCP).

Other cameras might have registers in different addresses. The right way to handle this would be to parse the Zipped XML that the camera provides.

Public Types
enum	Types { TYPE_COM_CAM, TYPE_CAM_COM }
enum	OpCodes { OP_REG_WRITE, OP_REG_READ }
enum	Registers {   ADR_STREAM_PRT, ADR_STREAM_ADR, ADR_PRIV, ADR_WIDTH,   ADR_HEIGHT, ADR_OFFS_X, ADR_OFFS_Y, ADR_PIX_FMT,   ADR_ACQ_CTL, ADR_FPS, ADR_EXPO_RAW, ADR_GAMMA_RAW,   ADR_GAIN_RAW, ADR_STROBE_MOD, ADR_STROBE_DUR, ADR_STROBE_DEL }
enum	FramesPerSecond { FPS_15, FPS_7, FPS_3 }
enum	PixelFormats { PIX_MONO8, PIX_BGB8 }
enum	PrivilegeBitValues { PRIV_BV_EXCLUSIVE, PRIV_BV_CONTROL }
enum	StrobeModes { STROBE_MODE_OFF, STROBE_MODE_ALWAYS_ON, STROBE_MODE_FIXED, STROBE_MODE_EXPOSURE }
enum	StrobeBitValues { STROBE_BV_ON_OFF, STROBE_BV_POLARITY, STROBE_BV_EXPOSURE }

Public Member Functions
	GVCP (const Address &cam_addr)
	~GVCP (void)
void	setPrivilege (unsigned bits)
void	setStreamPort (uint16_t port)
void	setStreamAddress (const Address &address)
void	setPixelFormat (PixelFormats format)
void	setFPS (FramesPerSecond fps)
void	setFPS (unsigned fps)
void	setExposureTime (double exposure)
void	setGain (unsigned gain)
void	setGamma (unsigned gamma)
void	setStrobeMode (StrobeModes mode, bool polarity=true)
void	setStrobeDelay (int32_t delay)
void	setStrobeDuration (uint32_t duration)
void	startStreaming (void)
void	stopStreaming (void)
void	keepAlive (void)

Member Enumeration Documentation

enum Vision::DFK51BG02H::GVCP::FramesPerSecond

Frames per second.

Enumerator
FPS_15
FPS_7
FPS_3

enum Vision::DFK51BG02H::GVCP::OpCodes

Operation code.

Enumerator
OP_REG_WRITE	Register write request.
OP_REG_READ	Register read request.

enum Vision::DFK51BG02H::GVCP::PixelFormats

Pixel formats.

Enumerator
PIX_MONO8	Grayscale, 1 byte per pixel.
PIX_BGB8	Bayer GB8, 1 byte per pixel.

enum Vision::DFK51BG02H::GVCP::PrivilegeBitValues

Privilege bits.

Enumerator
PRIV_BV_EXCLUSIVE
PRIV_BV_CONTROL

enum Vision::DFK51BG02H::GVCP::Registers

Register addresses.

Enumerator
ADR_STREAM_PRT	Primary stream destination port.
ADR_STREAM_ADR	Primary stream destination address.
ADR_PRIV	Control privilege.
ADR_WIDTH	Picture width (fixed).
ADR_HEIGHT	Picture height (fixed).
ADR_OFFS_X	Picture offset (X).
ADR_OFFS_Y	Picture offset (Y).
ADR_PIX_FMT	Pixel format.
ADR_ACQ_CTL	Acquisition control: start/stop.
ADR_FPS	Frames per second.
ADR_EXPO_RAW	Exposure time (raw).
ADR_GAMMA_RAW	Gamma (raw).
ADR_GAIN_RAW	Gain (raw).
ADR_STROBE_MOD	Strobe mode.
ADR_STROBE_DUR	Strobe duration.
ADR_STROBE_DEL	Strobe delay.

enum Vision::DFK51BG02H::GVCP::StrobeBitValues

Strobe bit values.

Enumerator
STROBE_BV_ON_OFF	Bit that controls on/off.
STROBE_BV_POLARITY	Bit that sets signal polarity.
STROBE_BV_EXPOSURE	Bit that ties the duration to exposure time.

enum Vision::DFK51BG02H::GVCP::StrobeModes

Strobe modes.

Enumerator
STROBE_MODE_OFF
STROBE_MODE_ALWAYS_ON
STROBE_MODE_FIXED
STROBE_MODE_EXPOSURE

enum Vision::DFK51BG02H::GVCP::Types

Message types.

Enumerator
TYPE_COM_CAM	Computer to camera.
TYPE_CAM_COM	Camera to computer.

Constructor & Destructor Documentation

Vision::DFK51BG02H::GVCP::GVCP ( const Address &  cam_addr )

inline

Vision::DFK51BG02H::GVCP::~GVCP ( void  )

inline

References setPrivilege(), and stopStreaming().

Member Function Documentation

void Vision::DFK51BG02H::GVCP::keepAlive ( void  )

inline

Send keep-alive signal.

References ADR_PRIV.

Referenced by Vision::DFK51BG02H::Task::onMain().

void Vision::DFK51BG02H::GVCP::setExposureTime ( double  exposure )

inline

References ADR_EXPO_RAW.

Referenced by Vision::DFK51BG02H::Task::onMain(), and Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setFPS ( FramesPerSecond  fps )

inline

Configure number of frames per second.

Parameters

[in]

fps

frames per second.

References ADR_FPS.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization(), and setFPS().

void Vision::DFK51BG02H::GVCP::setFPS ( unsigned  fps )

inline

Configure number of frames per second.

Parameters

[in]

fps

frames per second.

References FPS_15, FPS_3, FPS_7, and setFPS().

void Vision::DFK51BG02H::GVCP::setGain ( unsigned  gain )

inline

Configure gain.

Parameters

[in]

gain

raw gain.

References ADR_GAIN_RAW.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setGamma ( unsigned  gamma )

inline

Configure gamma.

Parameters

[in]

gamma

raw gamma.

References ADR_GAMMA_RAW.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setPixelFormat ( PixelFormats  format )

inline

Set pixel format.

Parameters

[in]

format

pixel format.

References ADR_PIX_FMT.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setPrivilege ( unsigned  bits )

inline

Set access privileges. It's mandatory (or so I think)

References ADR_PRIV.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization(), and ~GVCP().

void Vision::DFK51BG02H::GVCP::setStreamAddress ( const Address &  address )

inline

Configure destination stream address (GVSP).

Parameters

[in]

address

destination IP address.

References ADR_STREAM_ADR.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setStreamPort ( uint16_t  port )

inline

Configure destination stream port (GVSP).

Parameters

[in]

port

UDP port.

References ADR_STREAM_PRT.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setStrobeDelay ( int32_t  delay )

inline

Set strobe delay.

Parameters

[in]

delay

strobe delay.

References ADR_STROBE_DEL.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setStrobeDuration ( uint32_t  duration )

inline

Set strobe duration.

Parameters

[in]

duration

strobe duration.

References ADR_STROBE_DUR.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::setStrobeMode ( StrobeModes  mode, bool  polarity = true  )

inline

Configure strobe mode.

Parameters

[in]	mode	strobe mode.
[in]	polarity	strobe polarity, false means inverted polarity.

References ADR_STROBE_DEL, ADR_STROBE_DUR, ADR_STROBE_MOD, STROBE_BV_EXPOSURE, STROBE_BV_ON_OFF, STROBE_BV_POLARITY, STROBE_MODE_ALWAYS_ON, STROBE_MODE_EXPOSURE, STROBE_MODE_FIXED, and STROBE_MODE_OFF.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization(), and stopStreaming().

void Vision::DFK51BG02H::GVCP::startStreaming ( void  )

inline

Start streaming.

References ADR_ACQ_CTL.

Referenced by Vision::DFK51BG02H::Task::onResourceInitialization().

void Vision::DFK51BG02H::GVCP::stopStreaming ( void  )

inline

Stop streaming.

References ADR_ACQ_CTL, setStrobeMode(), and STROBE_MODE_OFF.

Referenced by ~GVCP().

Collaboration diagram for Vision::DFK51BG02H::GVCP: