doc/sdk/_pv_stream_8h_source.html

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

//

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

//

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


#ifndef __PVSTREAM_H__

#define __PVSTREAM_H__


#ifndef EBUS_ENUM

#define EBUS_ENUM(x) typedef enum

#endif


#include <PvStreamLib.h>


#include <PvBuffer.h>

#include <PvStreamEventSink.h>

#include <PvGenParameterArray.h>


namespace PvStreamLib

{

    class Stream;

}


class PvDeviceInfo;

class PvConfigurationWriter;

class PvConfigurationReader;

class PvPipeline;


EBUS_ENUM(PvStreamType)

{

    PvStreamTypeUnknown = -1,

    PvStreamTypeGEV = 0,

    PvStreamTypeU3V = 1,

    PvStreamTypeRTP = 2


} PvStreamType;


class PV_STREAM_API PvStream

{

public:


    virtual ~PvStream();


    uint32_t GetQueuedBufferCount() const;


    uint32_t GetQueuedBufferMaximum() const;


    static PvStream *CreateAndOpen( const PvDeviceInfo *aDeviceInfo, PvResult *aResult );


    static PvStream *CreateAndOpen( const PvString &aInfo, PvResult *aResult );


    static void Free( PvStream *aStream );


    virtual PvResult Open( const PvDeviceInfo *aDeviceInfo ) = 0;

    virtual PvResult Open( const PvString &aInfo ) = 0;


    PvResult Close();


    virtual PvStreamType GetType() const;


    PvResult AbortQueuedBuffers();


    PvResult QueueBuffer( PvBuffer * aBuffer );


    PvResult RetrieveBuffer( PvBuffer ** aBuffer, PvResult * aOperationResult, uint32_t aTimeout = 0xFFFFFFFF );


    uint16_t GetChannel();


    bool IsOpen() const;


    PvResult RegisterEventSink( PvStreamEventSink *aEventSink );


    PvResult UnregisterEventSink( PvStreamEventSink *aEventSink );


    PvGenParameterArray *GetParameters();


protected:


    PvStream();


    PvStreamLib::Stream *mThis;


private:


     // Not implemented

    PvStream( const PvStream & );

    const PvStream &operator=( const PvStream & );


    friend class PvPipeline;

};


#endif