Class Spinnaker::ICameraBase¶

ClassList > Spinnaker > ICameraBase

The interface file for base class for the camera object.

#include <ICameraBase.h>

Inherited by the following classes: Spinnaker::CameraBase

Public Attributes¶

Type	Name
TransportLayerDevice	TLDevice
TransportLayerStream	TLStream

Public Functions¶

Type	Name
virtual void	BeginAcquisition () = 0
virtual void	DeInit () = 0
virtual unsigned int	DiscoverMaxPacketSize () = 0
virtual void	EndAcquisition () = 0
virtual void	ForceIP () = 0
virtual GenApi::EAccessMode	GetAccessMode () const = 0
virtual unsigned int	GetActiveNumDataStreams () = 0
virtual BufferOwnership	GetBufferOwnership () const = 0
virtual GenICam::gcstring	GetDeviceID () = 0
virtual GenICam::gcstring	GetGuiXml () const = 0
virtual ImagePtr	GetNextImage (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE, uint64_t streamIndex=0) = 0
virtual ImageList	GetNextImageSync (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE) = 0
virtual GenApi::INodeMap &	GetNodeMap () const = 0
virtual unsigned int	GetNumDataStreams () = 0
virtual unsigned int	GetNumImagesInUse () = 0
virtual ProducerPtr	GetProducer () const = 0
virtual GenApi::INodeMap &	GetTLDeviceNodeMap () const = 0
virtual GenApi::INodeMap &	GetTLStreamNodeMap (uint64_t streamIndex) const = 0
virtual GenICam::gcstring	GetUniqueID () = 0
virtual uint64_t	GetUserBufferCount () const = 0
virtual uint64_t	GetUserBufferSize () const = 0
virtual uint64_t	GetUserBufferTotalSize () const = 0
virtual void	Init () = 0
virtual bool	IsInitialized () = 0
virtual bool	IsStreaming () const = 0
virtual bool	IsValid () = 0
virtual void	ReadPort (uint64_t iAddress, void * pBuffer, size_t iSize) = 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	SetBufferOwnership (const BufferOwnership mode) = 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 void	UnregisterAllLoggingEventHandlers () = 0
virtual void	UnregisterEventHandler (EventHandler & evtHandlerToUnregister) = 0
virtual void	WritePort (uint64_t iAddress, const void * pBuffer, size_t iSize) = 0
virtual	~ICameraBase (void)

Protected Attributes¶

Type	Name
CameraBaseData *	m_pCameraBaseData

Protected Functions¶

Type	Name
	ICameraBase ()
	ICameraBase (const ICameraBase &)
ICameraBase &	operator= (const ICameraBase &)

Public Attributes Documentation¶

variable TLDevice¶

TransportLayerDevice Spinnaker::ICameraBase::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.

variable TLStream¶

TransportLayerStream Spinnaker::ICameraBase::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.

Public Functions Documentation¶

function BeginAcquisition¶

virtual void Spinnaker::ICameraBase::BeginAcquisition () = 0

function DeInit¶

virtual void Spinnaker::ICameraBase::DeInit () = 0

function DiscoverMaxPacketSize¶

virtual unsigned int Spinnaker::ICameraBase::DiscoverMaxPacketSize () = 0

function EndAcquisition¶

virtual void Spinnaker::ICameraBase::EndAcquisition () = 0

function ForceIP¶

virtual void Spinnaker::ICameraBase::ForceIP () = 0

function GetAccessMode¶

virtual GenApi::EAccessMode Spinnaker::ICameraBase::GetAccessMode () const = 0

function GetActiveNumDataStreams¶

virtual unsigned int Spinnaker::ICameraBase::GetActiveNumDataStreams () = 0

function GetBufferOwnership¶

virtual BufferOwnership Spinnaker::ICameraBase::GetBufferOwnership () const = 0

function GetDeviceID¶

virtual GenICam::gcstring Spinnaker::ICameraBase::GetDeviceID () = 0

function GetGuiXml¶

virtual GenICam::gcstring Spinnaker::ICameraBase::GetGuiXml () const = 0

function GetNextImage¶

virtual ImagePtr Spinnaker::ICameraBase::GetNextImage (
    uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE,
    uint64_t streamIndex=0
) = 0

function GetNextImageSync¶

virtual ImageList Spinnaker::ICameraBase::GetNextImageSync (
    uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE
) = 0

function GetNodeMap¶

virtual GenApi::INodeMap & Spinnaker::ICameraBase::GetNodeMap () const = 0

function GetNumDataStreams¶

virtual unsigned int Spinnaker::ICameraBase::GetNumDataStreams () = 0

function GetNumImagesInUse¶

virtual unsigned int Spinnaker::ICameraBase::GetNumImagesInUse () = 0

function GetProducer¶

virtual ProducerPtr Spinnaker::ICameraBase::GetProducer () const = 0

function GetTLDeviceNodeMap¶

virtual GenApi::INodeMap & Spinnaker::ICameraBase::GetTLDeviceNodeMap () const = 0

function GetTLStreamNodeMap¶

virtual GenApi::INodeMap & Spinnaker::ICameraBase::GetTLStreamNodeMap (
    uint64_t streamIndex
) const = 0

function GetUniqueID¶

virtual GenICam::gcstring Spinnaker::ICameraBase::GetUniqueID () = 0

function GetUserBufferCount¶

virtual uint64_t Spinnaker::ICameraBase::GetUserBufferCount () const = 0

function GetUserBufferSize¶

virtual uint64_t Spinnaker::ICameraBase::GetUserBufferSize () const = 0

function GetUserBufferTotalSize¶

virtual uint64_t Spinnaker::ICameraBase::GetUserBufferTotalSize () const = 0

function Init¶

virtual void Spinnaker::ICameraBase::Init () = 0

function IsInitialized¶

virtual bool Spinnaker::ICameraBase::IsInitialized () = 0

function IsStreaming¶

virtual bool Spinnaker::ICameraBase::IsStreaming () const = 0

function IsValid¶

virtual bool Spinnaker::ICameraBase::IsValid () = 0

function ReadPort¶

virtual void Spinnaker::ICameraBase::ReadPort (
    uint64_t iAddress,
    void * pBuffer,
    size_t iSize
) = 0

function RegisterEventHandler [1/3]¶

virtual void Spinnaker::ICameraBase::RegisterEventHandler (
    EventHandler & evtHandlerToRegister
) = 0

function RegisterEventHandler [2/3]¶

virtual void Spinnaker::ICameraBase::RegisterEventHandler (
    DeviceEventHandler & evtHandlerToRegister,
    const GenICam::gcstring & eventName
) = 0

function RegisterEventHandler [3/3]¶

virtual void Spinnaker::ICameraBase::RegisterEventHandler (
    ImageEventHandler & evtHandlerToRegister,
    uint64_t streamIndex
) = 0

function SetBufferOwnership¶

virtual void Spinnaker::ICameraBase::SetBufferOwnership (
    const BufferOwnership mode
) = 0

function SetUserBuffers [1/2]¶

virtual void Spinnaker::ICameraBase::SetUserBuffers (
    void *const pMemBuffers,
    uint64_t totalSize
) = 0

function SetUserBuffers [2/2]¶

virtual void Spinnaker::ICameraBase::SetUserBuffers (
    void **const ppMemBuffers,
    const uint64_t bufferCount,
    const uint64_t bufferSize
) = 0

function UnregisterAllLoggingEventHandlers¶

virtual void Spinnaker::ICameraBase::UnregisterAllLoggingEventHandlers () = 0

function UnregisterEventHandler¶

virtual void Spinnaker::ICameraBase::UnregisterEventHandler (
    EventHandler & evtHandlerToUnregister
) = 0

function WritePort¶

virtual void Spinnaker::ICameraBase::WritePort (
    uint64_t iAddress,
    const void * pBuffer,
    size_t iSize
) = 0

function ~ICameraBase¶

inline virtual Spinnaker::ICameraBase::~ICameraBase (
    void
)

Protected Attributes Documentation¶

variable m_pCameraBaseData¶

CameraBaseData* Spinnaker::ICameraBase::m_pCameraBaseData;

Protected Functions Documentation¶

function ICameraBase [1/2]¶

inline Spinnaker::ICameraBase::ICameraBase ()

function ICameraBase [2/2]¶

inline Spinnaker::ICameraBase::ICameraBase (
    const ICameraBase &
)

function operator=¶

ICameraBase & Spinnaker::ICameraBase::operator= (
    const ICameraBase &
)

The documentation for this class was generated from the following file C:/workspace/include/Interface/ICameraBase.h