AVT::VmbAPI::Camera Class Reference

#include <Camera.h>

Inheritance diagram for AVT::VmbAPI::Camera:

List of all members.

Classes
struct	Impl
Public Member Functions
VmbErrorType	AcquireMultipleImages (FramePtrVector &frames, VmbUint32_t timeout)
VmbErrorType	AcquireMultipleImages (FramePtrVector &frames, VmbUint32_t timeout, VmbUint32_t &numFramesCompleted)
IMEXPORT VmbErrorType	AcquireSingleImage (FramePtr &pFrame, VmbUint32_t timeout)
IMEXPORT VmbErrorType	AnnounceFrame (const FramePtr &pFrame)
IMEXPORT	Camera (const char *pID, const char *pName, const char *pModel, const char *pSerialNumber, const char *pInterfaceID, VmbInterfaceType interfaceType)
virtual IMEXPORT VmbErrorType	Close ()
IMEXPORT VmbErrorType	EndCapture ()
IMEXPORT VmbErrorType	FlushQueue ()
VmbErrorType	GetID (std::string &cameraID) const
VmbErrorType	GetInterfaceID (std::string &interfaceID) const
IMEXPORT VmbErrorType	GetInterfaceType (VmbInterfaceType &interfaceType) const
VmbErrorType	GetModel (std::string &model) const
VmbErrorType	GetName (std::string &name) const
IMEXPORT VmbErrorType	GetPermittedAccess (VmbAccessModeType &permittedAccess) const
VmbErrorType	GetSerialNumber (std::string &serialNumber) const
VmbErrorType	LoadCameraSettings (std::string fileName, VmbFeaturePersistSettings_t *pSettings=0) const
IMEXPORT void	LoadSaveSettingsSetup (VmbFeaturePersist_t persistType, VmbUint32_t maxIterations, VmbUint32_t loggingLevel)
virtual IMEXPORT VmbErrorType	Open (VmbAccessModeType accessMode)
IMEXPORT VmbErrorType	QueueFrame (const FramePtr &pFrame)
virtual VmbErrorType	ReadMemory (const VmbUint64_t &address, UcharVector &buffer) const
virtual VmbErrorType	ReadMemory (const VmbUint64_t &address, UcharVector &buffer, VmbUint32_t &completeReads) const
virtual VmbErrorType	ReadRegisters (const Uint64Vector &addresses, Uint64Vector &buffer) const
virtual VmbErrorType	ReadRegisters (const Uint64Vector &addresses, Uint64Vector &buffer, VmbUint32_t &completedReads) const
IMEXPORT VmbErrorType	RevokeAllFrames ()
IMEXPORT VmbErrorType	RevokeFrame (const FramePtr &pFrame)
VmbErrorType	SaveCameraSettings (std::string fileName, VmbFeaturePersistSettings_t *pSettings=0) const
IMEXPORT VmbErrorType	StartCapture ()
IMEXPORT VmbErrorType	StartContinuousImageAcquisition (int bufferCount, const IFrameObserverPtr &pObserver)
IMEXPORT VmbErrorType	StopContinuousImageAcquisition ()
virtual VmbErrorType	WriteMemory (const VmbUint64_t &address, const UcharVector &buffer)
virtual VmbErrorType	WriteMemory (const VmbUint64_t &address, const UcharVector &buffer, VmbUint32_t &sizeComplete)
virtual VmbErrorType	WriteRegisters (const Uint64Vector &addresses, const Uint64Vector &buffer)
virtual VmbErrorType	WriteRegisters (const Uint64Vector &addresses, const Uint64Vector &buffer, VmbUint32_t &completedWrites)
virtual IMEXPORT	~Camera ()
Private Member Functions
IMEXPORT VmbErrorType	AcquireMultipleImages (FramePtr *pFrames, VmbUint32_t size, VmbUint32_t nTimeout, VmbUint32_t *pNumFramesCompleted)
	Camera ()
	Camera (const Camera &)
IMEXPORT VmbErrorType	GetID (char *const pID, VmbUint32_t &length) const
IMEXPORT VmbErrorType	GetInterfaceID (char *const pInterfaceID, VmbUint32_t &length) const
IMEXPORT VmbErrorType	GetModel (char *const pModelName, VmbUint32_t &length) const
IMEXPORT VmbErrorType	GetName (char *const pName, VmbUint32_t &length) const
IMEXPORT VmbErrorType	GetSerialNumber (char *const pSerial, VmbUint32_t &length) const
IMEXPORT VmbErrorType	LoadCameraSettings (const char *const pStrFileName, VmbFeaturePersistSettings_t *pSettings) const
Camera &	operator= (const Camera &)
virtual IMEXPORT VmbErrorType	ReadMemory (VmbUint64_t address, VmbUchar_t *pBuffer, VmbUint32_t bufferSize, VmbUint32_t *pSizeComplete) const
virtual IMEXPORT VmbErrorType	ReadRegisters (const VmbUint64_t *pAddressArray, VmbUint32_t addressSize, VmbUint64_t *pDataArray, VmbUint32_t *pCompletedReads) const
IMEXPORT VmbErrorType	SaveCameraSettings (const char *const pStrFileName, VmbFeaturePersistSettings_t *pSettings) const
virtual IMEXPORT VmbErrorType	WriteMemory (VmbUint64_t address, const VmbUchar_t *pBuffer, VmbUint32_t bufferSize, VmbUint32_t *pSizeComplete)
virtual IMEXPORT VmbErrorType	WriteRegisters (const VmbUint64_t *pAddressArray, VmbUint32_t addressSize, const VmbUint64_t *pDataArray, VmbUint32_t *pCompletedWrites)
Private Attributes
VmbUint32_t	m_loggingLevel
VmbUint32_t	m_maxIterations
VmbFeaturePersist_t	m_persistType
Impl *	m_pImpl

---

Detailed Description

Definition at line 47 of file Camera.h.

---

Constructor & Destructor Documentation

AVT::VmbAPI::Camera::Camera	(	const char *	pID,
		const char *	pName,
		const char *	pModel,
		const char *	pSerialNumber,
		const char *	pInterfaceID,
		VmbInterfaceType	interfaceType
	)

Definition at line 497 of file Camera.cpp.

AVT::VmbAPI::Camera::~Camera

(

)

[virtual]

Definition at line 526 of file Camera.cpp.

AVT::VmbAPI::Camera::Camera

(

)

[private]

Definition at line 481 of file Camera.cpp.

AVT::VmbAPI::Camera::Camera

(

const Camera &

)

[private]

Definition at line 486 of file Camera.cpp.

---

Member Function Documentation

VmbErrorType AVT::VmbAPI::Camera::AcquireMultipleImages	(	FramePtrVector &	frames,
		VmbUint32_t	timeout
	)

VmbErrorType AVT::VmbAPI::Camera::AcquireMultipleImages	(	FramePtrVector &	frames,
		VmbUint32_t	timeout,
		VmbUint32_t &	numFramesCompleted
	)

VmbErrorType AVT::VmbAPI::Camera::AcquireMultipleImages	(	FramePtr *	pFrames,
		VmbUint32_t	size,
		VmbUint32_t	nTimeout,
		VmbUint32_t *	pNumFramesCompleted
	)		[private]

Definition at line 791 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::AcquireSingleImage	(	FramePtr &	pFrame,
		VmbUint32_t	timeout
	)

Definition at line 750 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::AnnounceFrame

(

const FramePtr &

pFrame

)

Definition at line 963 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::Close

(

)

[virtual]

Definition at line 555 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::EndCapture

(

)

Definition at line 1208 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::FlushQueue

(

)

Definition at line 1150 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetID

(

std::string &

cameraID

)

const

VmbErrorType AVT::VmbAPI::Camera::GetID	(	char *const	pID,
		VmbUint32_t &	length
	)		const [private]

Definition at line 580 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetInterfaceID

(

std::string &

interfaceID

)

const

VmbErrorType AVT::VmbAPI::Camera::GetInterfaceID	(	char *const	pInterfaceID,
		VmbUint32_t &	length
	)		const [private]

Definition at line 676 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetInterfaceType

(

VmbInterfaceType &

interfaceType

)

const

Definition at line 700 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetModel

(

std::string &

model

)

const

VmbErrorType AVT::VmbAPI::Camera::GetModel	(	char *const	pModelName,
		VmbUint32_t &	length
	)		const [private]

Definition at line 628 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetName

(

std::string &

name

)

const

VmbErrorType AVT::VmbAPI::Camera::GetName	(	char *const	pName,
		VmbUint32_t &	length
	)		const [private]

Definition at line 604 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetPermittedAccess

(

VmbAccessModeType &

permittedAccess

)

const

Definition at line 707 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::GetSerialNumber

(

std::string &

serialNumber

)

const

VmbErrorType AVT::VmbAPI::Camera::GetSerialNumber	(	char *const	pSerial,
		VmbUint32_t &	length
	)		const [private]

Definition at line 652 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::LoadCameraSettings	(	std::string	fileName,
		VmbFeaturePersistSettings_t *	pSettings = 0
	)		const

VmbErrorType AVT::VmbAPI::Camera::LoadCameraSettings	(	const char *const	pStrFileName,
		VmbFeaturePersistSettings_t *	pSettings
	)		const [private]

Definition at line 1295 of file Camera.cpp.

void AVT::VmbAPI::Camera::LoadSaveSettingsSetup	(	VmbFeaturePersist_t	persistType,
		VmbUint32_t	maxIterations,
		VmbUint32_t	loggingLevel
	)

Definition at line 1331 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::Open

(

VmbAccessModeType

accessMode

)

[virtual]

Definition at line 533 of file Camera.cpp.

Camera & AVT::VmbAPI::Camera::operator=

(

const Camera &

)

[private]

Definition at line 491 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::QueueFrame

(

const FramePtr &

pFrame

)

Definition at line 1108 of file Camera.cpp.

virtual VmbErrorType AVT::VmbAPI::Camera::ReadMemory	(	const VmbUint64_t &	address,
		UcharVector &	buffer
	)		const [virtual]

Implements AVT::VmbAPI::IRegisterDevice.

virtual VmbErrorType AVT::VmbAPI::Camera::ReadMemory	(	const VmbUint64_t &	address,
		UcharVector &	buffer,
		VmbUint32_t &	completeReads
	)		const [virtual]

Implements AVT::VmbAPI::IRegisterDevice.

VmbErrorType AVT::VmbAPI::Camera::ReadMemory	(	VmbUint64_t	address,
		VmbUchar_t *	pBuffer,
		VmbUint32_t	bufferSize,
		VmbUint32_t *	pSizeComplete
	)		const [private, virtual]

Definition at line 739 of file Camera.cpp.

virtual VmbErrorType AVT::VmbAPI::Camera::ReadRegisters	(	const Uint64Vector &	addresses,
		Uint64Vector &	buffer
	)		const [virtual]

Implements AVT::VmbAPI::IRegisterDevice.

virtual VmbErrorType AVT::VmbAPI::Camera::ReadRegisters	(	const Uint64Vector &	addresses,
		Uint64Vector &	buffer,
		VmbUint32_t &	completedReads
	)		const [virtual]

Implements AVT::VmbAPI::IRegisterDevice.

VmbErrorType AVT::VmbAPI::Camera::ReadRegisters	(	const VmbUint64_t *	pAddressArray,
		VmbUint32_t	addressSize,
		VmbUint64_t *	pDataArray,
		VmbUint32_t *	pCompletedReads
	)		const [private, virtual]

Definition at line 729 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::RevokeAllFrames

(

)

Definition at line 1063 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::RevokeFrame

(

const FramePtr &

pFrame

)

Definition at line 1005 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::SaveCameraSettings	(	std::string	fileName,
		VmbFeaturePersistSettings_t *	pSettings = 0
	)		const

VmbErrorType AVT::VmbAPI::Camera::SaveCameraSettings	(	const char *const	pStrFileName,
		VmbFeaturePersistSettings_t *	pSettings
	)		const [private]

Definition at line 1252 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::StartCapture

(

)

Definition at line 1203 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::StartContinuousImageAcquisition	(	int	bufferCount,
		const IFrameObserverPtr &	pObserver
	)

Definition at line 852 of file Camera.cpp.

VmbErrorType AVT::VmbAPI::Camera::StopContinuousImageAcquisition

(

)

Definition at line 922 of file Camera.cpp.

virtual VmbErrorType AVT::VmbAPI::Camera::WriteMemory	(	const VmbUint64_t &	address,
		const UcharVector &	buffer
	)		[virtual]

Implements AVT::VmbAPI::IRegisterDevice.

virtual VmbErrorType AVT::VmbAPI::Camera::WriteMemory	(	const VmbUint64_t &	address,
		const UcharVector &	buffer,
		VmbUint32_t &	sizeComplete
	)		[virtual]

Implements AVT::VmbAPI::IRegisterDevice.

VmbErrorType AVT::VmbAPI::Camera::WriteMemory	(	VmbUint64_t	address,
		const VmbUchar_t *	pBuffer,
		VmbUint32_t	bufferSize,
		VmbUint32_t *	pSizeComplete
	)		[private, virtual]

Definition at line 744 of file Camera.cpp.

virtual VmbErrorType AVT::VmbAPI::Camera::WriteRegisters	(	const Uint64Vector &	addresses,
		const Uint64Vector &	buffer
	)		[virtual]

Implements AVT::VmbAPI::IRegisterDevice.

virtual VmbErrorType AVT::VmbAPI::Camera::WriteRegisters	(	const Uint64Vector &	addresses,
		const Uint64Vector &	buffer,
		VmbUint32_t &	completedWrites
	)		[virtual]

Implements AVT::VmbAPI::IRegisterDevice.

VmbErrorType AVT::VmbAPI::Camera::WriteRegisters	(	const VmbUint64_t *	pAddressArray,
		VmbUint32_t	addressSize,
		const VmbUint64_t *	pDataArray,
		VmbUint32_t *	pCompletedWrites
	)		[private, virtual]

Definition at line 734 of file Camera.cpp.

---

Member Data Documentation

VmbUint32_t AVT::VmbAPI::Camera::m_loggingLevel [private]

Definition at line 625 of file Camera.h.

VmbUint32_t AVT::VmbAPI::Camera::m_maxIterations [private]

Definition at line 624 of file Camera.h.

VmbFeaturePersist_t AVT::VmbAPI::Camera::m_persistType [private]

Definition at line 623 of file Camera.h.

Impl* AVT::VmbAPI::Camera::m_pImpl [private]

Reimplemented from AVT::VmbAPI::FeatureContainer.

Definition at line 606 of file Camera.h.

---

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

• Camera.h
• Camera.cpp