Skip to content

Class Spinnaker::IInterface

ClassList > Spinnaker > IInterface

The interface file for Interface .

  • #include <IInterface.h>

Inherited by the following classes: Spinnaker::Interface

Public Attributes

Type Name
TransportLayerInterface TLInterface

Public Functions

Type Name
virtual CameraList GetCameras (bool updateCameras=true) const = 0
virtual ProducerPtr GetProducer () const = 0
virtual GenApi::INodeMap & GetTLNodeMap () const = 0
virtual bool IsCameraInUse () const = 0
virtual bool IsValid () = 0
virtual void RegisterEventHandler (EventHandler & evtHandlerToRegister) = 0
virtual void SendActionCommand (unsigned int deviceKey, unsigned int groupKey, unsigned int groupMask, unsigned long long actionTime=0, bool requestAck=false, unsigned int * pResultSize=0, ActionCommandResult results=NULL) const = 0
virtual void UnregisterAllLoggingEventHandlers () = 0
virtual void UnregisterEventHandler (EventHandler & evtHandlerToUnregister) = 0
virtual bool UpdateCameras () = 0
virtual ~IInterface ()

Protected Attributes

Type Name
InterfaceData * m_pInterfaceData

Protected Functions

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

Public Attributes Documentation

variable TLInterface

TransportLayerInterface Spinnaker::IInterface::TLInterface;

Public Functions Documentation

function GetCameras

virtual CameraList Spinnaker::IInterface::GetCameras (
    bool updateCameras=true
) const = 0

function GetProducer

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

function GetTLNodeMap

virtual GenApi::INodeMap & Spinnaker::IInterface::GetTLNodeMap () const = 0

function IsCameraInUse

virtual bool Spinnaker::IInterface::IsCameraInUse () const = 0

function IsValid

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

function RegisterEventHandler

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

function SendActionCommand

virtual void Spinnaker::IInterface::SendActionCommand (
    unsigned int deviceKey,
    unsigned int groupKey,
    unsigned int groupMask,
    unsigned long long actionTime=0,
    bool requestAck=false,
    unsigned int * pResultSize=0,
    ActionCommandResult results=NULL
) const = 0

function UnregisterAllLoggingEventHandlers

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

function UnregisterEventHandler

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

function UpdateCameras

virtual bool Spinnaker::IInterface::UpdateCameras () = 0

function ~IInterface

inline virtual Spinnaker::IInterface::~IInterface () 

Protected Attributes Documentation

variable m_pInterfaceData

InterfaceData* Spinnaker::IInterface::m_pInterfaceData;

Protected Functions Documentation

function IInterface [1/2]

inline Spinnaker::IInterface::IInterface () 

function IInterface [2/2]

inline Spinnaker::IInterface::IInterface (
    const IInterface &
) 

function operator=

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


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