Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
AVT::VmbAPI::Camera Class Reference

#include <Camera.h>

Inheritance diagram for AVT::VmbAPI::Camera:
Inheritance graph
[legend]

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 ()
 
- Public Member Functions inherited from AVT::VmbAPI::FeatureContainer
IMEXPORT FeatureContainer ()
 
IMEXPORT VmbErrorType GetFeatureByName (const char *pName, FeaturePtr &pFeature)
 
VmbErrorType GetFeatures (FeaturePtrVector &features)
 
VmbHandle_t GetHandle () const
 
IMEXPORT ~FeatureContainer ()
 
- Public Member Functions inherited from AVT::VmbAPI::BasicLockable
IMEXPORT BasicLockable ()
 
IMEXPORT BasicLockable (MutexPtr pMutex)
 
MutexPtr & GetMutex ()
 
const MutexPtr & GetMutex () const
 
void Lock ()
 
void Unlock ()
 
virtual IMEXPORT ~BasicLockable ()
 
- Public Member Functions inherited from AVT::VmbAPI::IRegisterDevice
virtual ~IRegisterDevice ()
 

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
 
Cameraoperator= (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
 
Implm_pImpl
 

Additional Inherited Members

- Protected Member Functions inherited from AVT::VmbAPI::FeatureContainer
void Reset ()
 
void RevokeHandle ()
 
void SetHandle (const VmbHandle_t handle)
 

Detailed Description

Definition at line 47 of file Camera.h.

Constructor & Destructor Documentation

◆ Camera() [1/3]

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

Definition at line 501 of file Camera.cpp.

◆ ~Camera()

AVT::VmbAPI::Camera::~Camera ( )
virtual

Definition at line 530 of file Camera.cpp.

◆ Camera() [2/3]

AVT::VmbAPI::Camera::Camera ( )
private

Definition at line 485 of file Camera.cpp.

◆ Camera() [3/3]

AVT::VmbAPI::Camera::Camera ( const Camera )
private

Definition at line 490 of file Camera.cpp.

Member Function Documentation

◆ AcquireMultipleImages() [1/3]

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

Definition at line 795 of file Camera.cpp.

◆ AcquireMultipleImages() [2/3]

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

◆ AcquireMultipleImages() [3/3]

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

◆ AcquireSingleImage()

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

Definition at line 754 of file Camera.cpp.

◆ AnnounceFrame()

VmbErrorType AVT::VmbAPI::Camera::AnnounceFrame ( const FramePtr &  pFrame)

Definition at line 970 of file Camera.cpp.

◆ Close()

VmbErrorType AVT::VmbAPI::Camera::Close ( )
virtual

Definition at line 559 of file Camera.cpp.

◆ EndCapture()

VmbErrorType AVT::VmbAPI::Camera::EndCapture ( )

Definition at line 1198 of file Camera.cpp.

◆ FlushQueue()

VmbErrorType AVT::VmbAPI::Camera::FlushQueue ( )

Definition at line 1144 of file Camera.cpp.

◆ GetID() [1/2]

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

Definition at line 584 of file Camera.cpp.

◆ GetID() [2/2]

VmbErrorType AVT::VmbAPI::Camera::GetID ( std::string &  cameraID) const

◆ GetInterfaceID() [1/2]

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

Definition at line 680 of file Camera.cpp.

◆ GetInterfaceID() [2/2]

VmbErrorType AVT::VmbAPI::Camera::GetInterfaceID ( std::string &  interfaceID) const

◆ GetInterfaceType()

VmbErrorType AVT::VmbAPI::Camera::GetInterfaceType ( VmbInterfaceType interfaceType) const

Definition at line 704 of file Camera.cpp.

◆ GetModel() [1/2]

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

Definition at line 632 of file Camera.cpp.

◆ GetModel() [2/2]

VmbErrorType AVT::VmbAPI::Camera::GetModel ( std::string &  model) const

◆ GetName() [1/2]

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

Definition at line 608 of file Camera.cpp.

◆ GetName() [2/2]

VmbErrorType AVT::VmbAPI::Camera::GetName ( std::string &  name) const

◆ GetPermittedAccess()

VmbErrorType AVT::VmbAPI::Camera::GetPermittedAccess ( VmbAccessModeType permittedAccess) const

Definition at line 711 of file Camera.cpp.

◆ GetSerialNumber() [1/2]

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

Definition at line 656 of file Camera.cpp.

◆ GetSerialNumber() [2/2]

VmbErrorType AVT::VmbAPI::Camera::GetSerialNumber ( std::string &  serialNumber) const

◆ LoadCameraSettings() [1/2]

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

Definition at line 1311 of file Camera.cpp.

◆ LoadCameraSettings() [2/2]

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

◆ LoadSaveSettingsSetup()

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

Definition at line 1371 of file Camera.cpp.

◆ Open()

VmbErrorType AVT::VmbAPI::Camera::Open ( VmbAccessModeType  accessMode)
virtual

Definition at line 537 of file Camera.cpp.

◆ operator=()

Camera & AVT::VmbAPI::Camera::operator= ( const Camera )
private

Definition at line 495 of file Camera.cpp.

◆ QueueFrame()

VmbErrorType AVT::VmbAPI::Camera::QueueFrame ( const FramePtr &  pFrame)

Definition at line 1102 of file Camera.cpp.

◆ ReadMemory() [1/3]

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

◆ ReadMemory() [2/3]

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

◆ ReadMemory() [3/3]

VmbErrorType AVT::VmbAPI::Camera::ReadMemory ( VmbUint64_t  address,
VmbUchar_t pBuffer,
VmbUint32_t  bufferSize,
VmbUint32_t pSizeComplete 
) const
privatevirtual

Definition at line 743 of file Camera.cpp.

◆ ReadRegisters() [1/3]

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

◆ ReadRegisters() [2/3]

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

◆ ReadRegisters() [3/3]

VmbErrorType AVT::VmbAPI::Camera::ReadRegisters ( const VmbUint64_t pAddressArray,
VmbUint32_t  addressSize,
VmbUint64_t pDataArray,
VmbUint32_t pCompletedReads 
) const
privatevirtual

Definition at line 733 of file Camera.cpp.

◆ RevokeAllFrames()

VmbErrorType AVT::VmbAPI::Camera::RevokeAllFrames ( )

Definition at line 1064 of file Camera.cpp.

◆ RevokeFrame()

VmbErrorType AVT::VmbAPI::Camera::RevokeFrame ( const FramePtr &  pFrame)

Definition at line 1012 of file Camera.cpp.

◆ SaveCameraSettings() [1/2]

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

Definition at line 1242 of file Camera.cpp.

◆ SaveCameraSettings() [2/2]

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

◆ StartCapture()

VmbErrorType AVT::VmbAPI::Camera::StartCapture ( )

Definition at line 1193 of file Camera.cpp.

◆ StartContinuousImageAcquisition()

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

Definition at line 856 of file Camera.cpp.

◆ StopContinuousImageAcquisition()

VmbErrorType AVT::VmbAPI::Camera::StopContinuousImageAcquisition ( )

Definition at line 926 of file Camera.cpp.

◆ WriteMemory() [1/3]

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

◆ WriteMemory() [2/3]

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

◆ WriteMemory() [3/3]

VmbErrorType AVT::VmbAPI::Camera::WriteMemory ( VmbUint64_t  address,
const VmbUchar_t pBuffer,
VmbUint32_t  bufferSize,
VmbUint32_t pSizeComplete 
)
privatevirtual

Definition at line 748 of file Camera.cpp.

◆ WriteRegisters() [1/3]

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

◆ WriteRegisters() [2/3]

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

◆ WriteRegisters() [3/3]

VmbErrorType AVT::VmbAPI::Camera::WriteRegisters ( const VmbUint64_t pAddressArray,
VmbUint32_t  addressSize,
const VmbUint64_t pDataArray,
VmbUint32_t pCompletedWrites 
)
privatevirtual

Definition at line 738 of file Camera.cpp.

Member Data Documentation

◆ m_loggingLevel

VmbUint32_t AVT::VmbAPI::Camera::m_loggingLevel
private

Definition at line 625 of file Camera.h.

◆ m_maxIterations

VmbUint32_t AVT::VmbAPI::Camera::m_maxIterations
private

Definition at line 624 of file Camera.h.

◆ m_persistType

VmbFeaturePersist_t AVT::VmbAPI::Camera::m_persistType
private

Definition at line 623 of file Camera.h.

◆ m_pImpl

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

Definition at line 606 of file Camera.h.


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


avt_vimba_camera
Author(s): Allied Vision Technologies, Miquel Massot
autogenerated on Sat Jun 3 2023 02:14:12