Spinnaker SDK C++
4.2.0.21
 
 

 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
ICameraBase Class Referenceabstract
Spinnaker Classes | Spinnaker Classes » Camera Base Interface Class

The interface file for base class for the camera object. More...

#include <ICameraBase.h>

Inheritance diagram for ICameraBase:
CameraBase Camera

Public Member Functions

virtual ~ICameraBase (void)
 
virtual void Init ()=0
 
virtual void DeInit ()=0
 
virtual bool IsInitialized ()=0
 
virtual bool IsValid ()=0
 
virtual GenApi::INodeMap & GetNodeMap () const =0
 
virtual GenApi::INodeMap & GetTLDeviceNodeMap () const =0
 
virtual GenApi::INodeMap & GetTLStreamNodeMap (uint64_t streamIndex) const =0
 
virtual GenApi::EAccessMode GetAccessMode () const =0
 
virtual void ReadPort (uint64_t iAddress, void *pBuffer, size_t iSize)=0
 
virtual void WritePort (uint64_t iAddress, const void *pBuffer, size_t iSize)=0
 
virtual void BeginAcquisition ()=0
 
virtual void EndAcquisition ()=0
 
virtual BufferOwnership GetBufferOwnership () const =0
 
virtual void SetBufferOwnership (const BufferOwnership mode)=0
 
virtual uint64_t GetUserBufferCount () const =0
 
virtual uint64_t GetUserBufferSize () const =0
 
virtual uint64_t GetUserBufferTotalSize () const =0
 
virtual void SetUserBuffers (void *const pMemBuffers, uint64_t totalSize)=0
 
virtual void SetUserBuffers (void **const ppMemBuffers, const uint64_t bufferCount, const uint64_t bufferSize)=0
 
virtual ImagePtr GetNextImage (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE, uint64_t streamIndex=0)=0
 
virtual GenICam::gcstring GetDeviceID ()=0
 
virtual GenICam::gcstring GetUniqueID ()=0
 
virtual bool IsStreaming () const =0
 
virtual GenICam::gcstring GetGuiXml () const =0
 
virtual void RegisterEventHandler (EventHandler &evtHandlerToRegister)=0
 
virtual void RegisterEventHandler (DeviceEventHandler &evtHandlerToRegister, const GenICam::gcstring &eventName)=0
 
virtual void RegisterEventHandler (ImageEventHandler &evtHandlerToRegister, uint64_t streamIndex)=0
 
virtual void UnregisterEventHandler (EventHandler &evtHandlerToUnregister)=0
 
virtual unsigned int GetNumImagesInUse ()=0
 
virtual unsigned int GetActiveNumDataStreams ()=0
 
virtual unsigned int GetNumDataStreams ()=0
 
virtual unsigned int DiscoverMaxPacketSize ()=0
 
virtual void ForceIP ()=0
 

Public Attributes

TransportLayerDevice TLDevice
 Gets vital camera information by connecting to the camera's bootstrap registers.
 
TransportLayerStream TLStream
 Gets information about the stream data by connecting to the camera's bootstrap registers.
 

Protected Member Functions

 ICameraBase ()
 
 ICameraBase (const ICameraBase &)
 
ICameraBase & operator= (const ICameraBase &)
 

Protected Attributes

CameraBaseData * m_pCameraBaseData
 

Friends

class CameraInternal
 
class InterfaceImpl
 

Detailed Description

The interface file for base class for the camera object.

Constructor & Destructor Documentation

◆ ~ICameraBase()

virtual ~ICameraBase ( void  )
inlinevirtual

◆ ICameraBase() [1/2]

ICameraBase ( )
inlineprotected

◆ ICameraBase() [2/2]

ICameraBase ( const ICameraBase &  )
inlineprotected

Member Function Documentation

◆ BeginAcquisition()

virtual void BeginAcquisition ( )
pure virtual

Implemented in CameraBase.

◆ DeInit()

virtual void DeInit ( )
pure virtual

Implemented in CameraBase.

◆ DiscoverMaxPacketSize()

virtual unsigned int DiscoverMaxPacketSize ( )
pure virtual

Implemented in CameraBase.

◆ EndAcquisition()

virtual void EndAcquisition ( )
pure virtual

Implemented in CameraBase.

◆ ForceIP()

virtual void ForceIP ( )
pure virtual

Implemented in CameraBase.

◆ GetAccessMode()

virtual GenApi::EAccessMode GetAccessMode ( ) const
pure virtual

Implemented in CameraBase.

◆ GetActiveNumDataStreams()

virtual unsigned int GetActiveNumDataStreams ( )
pure virtual

Implemented in CameraBase.

◆ GetBufferOwnership()

virtual BufferOwnership GetBufferOwnership ( ) const
pure virtual

Implemented in CameraBase.

◆ GetDeviceID()

virtual GenICam::gcstring GetDeviceID ( )
pure virtual

Implemented in CameraBase.

◆ GetGuiXml()

virtual GenICam::gcstring GetGuiXml ( ) const
pure virtual

Implemented in CameraBase.

◆ GetNextImage()

virtual ImagePtr GetNextImage ( uint64_t  grabTimeout = EVENT_TIMEOUT_INFINITE,
uint64_t  streamIndex = 0 
)
pure virtual

Implemented in CameraBase.

◆ GetNodeMap()

virtual GenApi::INodeMap & GetNodeMap ( ) const
pure virtual

Implemented in CameraBase.

◆ GetNumDataStreams()

virtual unsigned int GetNumDataStreams ( )
pure virtual

Implemented in CameraBase.

◆ GetNumImagesInUse()

virtual unsigned int GetNumImagesInUse ( )
pure virtual

Implemented in CameraBase.

◆ GetTLDeviceNodeMap()

virtual GenApi::INodeMap & GetTLDeviceNodeMap ( ) const
pure virtual

Implemented in CameraBase.

◆ GetTLStreamNodeMap()

virtual GenApi::INodeMap & GetTLStreamNodeMap ( uint64_t  streamIndex) const
pure virtual

Implemented in CameraBase.

◆ GetUniqueID()

virtual GenICam::gcstring GetUniqueID ( )
pure virtual

◆ GetUserBufferCount()

virtual uint64_t GetUserBufferCount ( ) const
pure virtual

Implemented in CameraBase.

◆ GetUserBufferSize()

virtual uint64_t GetUserBufferSize ( ) const
pure virtual

Implemented in CameraBase.

◆ GetUserBufferTotalSize()

virtual uint64_t GetUserBufferTotalSize ( ) const
pure virtual

Implemented in CameraBase.

◆ Init()

virtual void Init ( )
pure virtual

Implemented in Camera, and CameraBase.

◆ IsInitialized()

virtual bool IsInitialized ( )
pure virtual

Implemented in CameraBase.

◆ IsStreaming()

virtual bool IsStreaming ( ) const
pure virtual

Implemented in CameraBase.

◆ IsValid()

virtual bool IsValid ( )
pure virtual

Implemented in CameraBase.

◆ operator=()

ICameraBase & operator= ( const ICameraBase &  )
protected

◆ ReadPort()

virtual void ReadPort ( uint64_t  iAddress,
void *  pBuffer,
size_t  iSize 
)
pure virtual

Implemented in CameraBase.

◆ RegisterEventHandler() [1/3]

virtual void RegisterEventHandler ( DeviceEventHandler &  evtHandlerToRegister,
const GenICam::gcstring &  eventName 
)
pure virtual

Implemented in CameraBase.

◆ RegisterEventHandler() [2/3]

virtual void RegisterEventHandler ( EventHandler &  evtHandlerToRegister)
pure virtual

Implemented in CameraBase.

◆ RegisterEventHandler() [3/3]

virtual void RegisterEventHandler ( ImageEventHandler &  evtHandlerToRegister,
uint64_t  streamIndex 
)
pure virtual

Implemented in CameraBase.

◆ SetBufferOwnership()

virtual void SetBufferOwnership ( const BufferOwnership  mode)
pure virtual

Implemented in CameraBase.

◆ SetUserBuffers() [1/2]

virtual void SetUserBuffers ( void **const  ppMemBuffers,
const uint64_t  bufferCount,
const uint64_t  bufferSize 
)
pure virtual

Implemented in CameraBase.

◆ SetUserBuffers() [2/2]

virtual void SetUserBuffers ( void *const  pMemBuffers,
uint64_t  totalSize 
)
pure virtual

Implemented in CameraBase.

◆ UnregisterEventHandler()

virtual void UnregisterEventHandler ( EventHandler &  evtHandlerToUnregister)
pure virtual

Implemented in CameraBase.

◆ WritePort()

virtual void WritePort ( uint64_t  iAddress,
const void *  pBuffer,
size_t  iSize 
)
pure virtual

Implemented in CameraBase.

Friends And Related Symbol Documentation

◆ CameraInternal

friend class CameraInternal
friend

◆ InterfaceImpl

friend class InterfaceImpl
friend

Member Data Documentation

◆ m_pCameraBaseData

CameraBaseData* m_pCameraBaseData
protected

◆ TLDevice

TransportLayerDevice TLDevice

Gets vital camera information by connecting to the camera's bootstrap registers.

These nodes also access host software modules and the nodes can be used without having to call Init() on the camera.

◆ TLStream

TransportLayerStream TLStream

Gets information about the stream data by connecting to the camera's bootstrap registers.

These nodes also access host software modules and the nodes can be used without having to call Init() on the camera. In cameras with multiple streams, will always represent Stream channel 0.

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