SDK-eBUS/Ubuntu-LTS/eBUS_SDK_JAI_Ubuntu-24.04-x86_64-7.0.1-7536.zip

// *****************************************************************************

//

//     Copyright (c) 2016, Pleora Technologies Inc., All rights reserved.

//

// *****************************************************************************


#ifndef __PVCAMERABRIDGE_H__

#define __PVCAMERABRIDGE_H__


#include <PvCameraBridgeLib.h>

#include <PvDeviceSerialEnums.h>

#include <PvStringList.h>

#include <PvConfigurationReader.h>

#include <PvConfigurationWriter.h>


class PvDevice;

class PvStream;

class PvGenParameterArray;


namespace PvCameraBridgeLib

{

    class CameraBridge;

}


typedef enum

{

    PvCameraBridgeUnknown = -1,

    PvCameraBridgePCF = 0,

    PvCameraBridgeCLP,

    PvCameraBridgeGenCP


} PvCameraBridgeType;


class PV_CAMERABRIDGE_API PvCameraBridgeEventSink

{

public:


    PvCameraBridgeEventSink();


    virtual ~PvCameraBridgeEventSink();


    virtual PvResult OnSetParameter( const PvString &aName, const PvString &aValue );


    virtual void OnError( const PvString &aMessage );


};


class PV_CAMERABRIDGE_API PvCameraBridge

{

public:


    PvCameraBridge( PvDevice *aDevice, PvDeviceSerial aPort, PvStream *aStream = NULL );


    virtual ~PvCameraBridge();


    PvGenParameterArray *GetParameters();


    bool IsConnected();


    PvResult Disconnect();


    PvResult Recover();


    PvDeviceSerial GetPort() const;


    PvDevice *GetDevice();


    PvStream *GetStream();


    PvResult StartAcquisition();


    PvResult StopAcquisition();


    bool GetParametersSyncEnabled() const;


    void SetParametersSyncEnabled( bool aEnabled );


    PvString GetSource() const;


    void SetSource( const PvString &aSource );


    PvResult RegisterEventSink( PvCameraBridgeEventSink *aEventSink );


    PvResult UnregisterEventSink( PvCameraBridgeEventSink *aEventSink );


    PvResult ConnectPleoraCameraFile( const PvString &aPath );


    PvResult GetPleoraCameraFileParserErrors( PvStringList &aErrors );


    PvResult GetPleoraCameraFilePath( PvString &aPath ) const;


    static PvResult GetCLProtocolTemplates( PvStringList &aTemplates );


    PvResult ProbeCLProtocol( const PvString &aTemplate,

                              PvString &aCameraID,

                              PvStringList &aXMLIDs );


    PvResult ConnectCLProtocol( const PvString &aTemplate, const PvString &aXMLID = "" );


    PvResult GetCLProtocolTemplate( PvString &aTemplate ) const;


    PvResult GetCLProtocolCameraID( PvString &aCameraID ) const;


    PvResult GetCLProtocolXMLID( PvString &aXMLID ) const;


    PvResult GetGenCPXMLIDs( PvStringList &aXMLIDs );


    PvResult ConnectGenCP( const PvString &aXMLID = "" );


    PvResult GetGenCPXMLID( PvString &aXMLID ) const;


    PvResult Save( const PvString &aPrefix, PvConfigurationWriter &aWriter );


    PvResult Load( const PvString &aPrefix, PvConfigurationReader &aReader, PvStringList &aErrors );


    uint64_t GetBytesSentToCamera() const;


    uint64_t GetBytesReceivedFromCamera() const;


    void ResetStatistics();


    static bool IsPoCLSupported( PvDevice *aDevice );


    static bool IsPoCLEnabled( PvDevice *aDevice );


    static PvResult SetPoCLEnabled( PvDevice *aDevice, bool aEnabled );


protected:


private:


    PvCameraBridgeLib::CameraBridge *mThis;


    // Not implemented

    PvCameraBridge( const PvCameraBridge & );

    const PvCameraBridge& operator=( const PvCameraBridge & );


};


#endif

PvDeviceSerialEnums.h
Device serial communication constants.

PvDeviceSerial
PvDeviceSerial
Device serial port enumeration.
Definition PvDeviceSerialEnums.h:20

PvCameraBridgeEventSink
Event sink interface for PvCameraBridge events.
Definition PvCameraBridge.h:49

PvCameraBridge
Bridge between a PvDevice and a camera connected through a serial port.
Definition PvCameraBridge.h:91

PvConfigurationReader
Reads and restores configuration data from persistence files.
Definition PvConfigurationReader.h:29

PvConfigurationWriter
Writes configuration data to persistence files.
Definition PvConfigurationWriter.h:29

PvDevice
Connect, configure and control a GigE Vision or USB3 Vision device.
Definition PvDevice.h:42

PvGenParameterArray
GenICam feature array.
Definition PvGenParameterArray.h:73

PvResult
Result information.
Definition PvResult.h:30

PvStream
Receive data from a GigE Vision or USB3 Vision transmitter.
Definition PvStream.h:51

PvString
String class.
Definition PvString.h:26

PvStringList
Class used to hold a group of PvString objects.
Definition PvStringList.h:20