7 #ifndef __PVSOFTDEVICEGEVINTERFACES_H__
8 #define __PVSOFTDEVICEGEVINTERFACES_H__
11 #define EBUS_ENUM(x) typedef enum
14 #include <PvVirtualDeviceLib.h>
28 namespace PvVirtualDeviceLib
35 PvScanTypeInvalid = -1,
507 virtual PvResult FireEvent( uint16_t aEventID, uint64_t aBlockID = 0, uint16_t aChannelIndex = 0xFFFF ) = 0;
535 virtual PvResult FireEvent( uint16_t aEventID, uint8_t *aData, uint32_t aDataLength, uint64_t aBlockID = 0, uint16_t aChannelIndex = 0xFFFF ) = 0;
589 PVUNREFPARAM( aDevice );
590 PVUNREFPARAM( aIPAddress );
591 PVUNREFPARAM( aPort );
592 PVUNREFPARAM( aAccessType );
609 PVUNREFPARAM( aDevice );
610 PVUNREFPARAM( aMACAddress );
611 PVUNREFPARAM( aIPAddress );
612 PVUNREFPARAM( aMask );
613 PVUNREFPARAM( aGateway );
614 PVUNREFPARAM( aPort );
802 virtual void GetWidthInfo( uint32_t &aMin, uint32_t &aMax, uint32_t &aInc )
const = 0;
814 virtual void GetHeightInfo( uint32_t &aMin, uint32_t &aMax, uint32_t &aInc )
const = 0;
1201 PVUNREFPARAM( aRegisterMap );
1202 PVUNREFPARAM( aFactory );
1267 PVUNREFPARAM( aRegisterMap );
1268 PVUNREFPARAM( aFactory );
1323 PVUNREFPARAM( aEnabled );
1324 PVUNREFPARAM( aMaxMultiPartCount );
1489 virtual PvResult Read( uint8_t *aData, uint32_t aByteCount, uint32_t aOffset = 0 ) = 0;
1502 virtual PvResult Write(
const uint8_t *aData, uint32_t aByteCount, uint32_t aOffset = 0 ) = 0;
2052 virtual void SetCategory(
const PvString &aCategory,
const PvString &aCategoryDisplayName ) = 0;
2197 virtual void SetPIsLocked(
const PvString &aFeatureName ) = 0;
2213 virtual void MapChunk( uint32_t aChunkID, uint32_t aAddress,
size_t aLength, PvGenEndianness aEndianness = PvGenEndiannessLittle ) = 0;
2230 virtual void MapEvent( uint32_t aEventID, uint32_t aAddress,
size_t aLength, PvGenEndianness aEndianness = PvGenEndiannessLittle,
bool aAdjustAddress =
true ) = 0;
2704 virtual PvResult SetPIsLockedFor(
const PvString &aStandardFeatureName,
const PvString &aPIsLockedFeatureName ) = 0;
PvDevice library enumerations.
PvAccessType
GigE Vision device access type.
Definition: PvDeviceEnums.h:54
GenICam feature-related constants.
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:61
PvGenRepresentation
Definition: PvGenTypes.h:159
PvPayloadType
GVSP payload type.
Definition: PvPayloadType.h:67
PvPixelType
Definition: PvPixelType.h:58
GenApi factory used to add custom GenApi parameters to a software-based GigE Vision Device GenICam XM...
Definition: PvSoftDeviceGEVInterfaces.h:1992
virtual void SetDisplayName(const PvString &aDisplayName)=0
Sets the display name of the next feature to be added to the GenICam XML.
virtual PvResult CreateFloatConverter(const PvString &aValueFeatureName, const PvString &aFromFormula, const PvString &aToFormula)=0
Adds a float Converter to the GenICam XML file using the current state of the factory for its attribu...
virtual PvResult SetPValueFor(const PvString &aStandardFeatureName, const PvString &aPValueFeatureName)=0
Forces a pValue reference for a feature managed by PvSoftDeviceGEV.
virtual PvResult CreateFloatSwissKnife(const PvString &aFormula)=0
Adds a float SwissKnife to the GenICam XML file using the current state of the factory for its attrib...
virtual PvResult SetPIsAvailableForEnumEntry(const PvString &aStandardFeatureName, const PvString &aEnumEntryName, const PvString &aPIsAvailableFeatureName)=0
Forces a pIsAvailable reference for a the enum entry of an enum feature managed by PvSoftDeviceGEV.
virtual void SetDescription(const PvString &aDescription)=0
Sets the description of the next feature to be added to the GenICam XML file.
virtual void SetPMax(const PvString &aFeatureName)=0
Sets node to use for integer or float dynamic maximum attribute.
virtual PvResult AddInvalidatorTo(const PvString &aStandardFeatureName, const PvString &aInvalidatorFeatureName)=0
Adds a a custom invalidator to a feature managed by PvSoftDeviceGEV.
virtual PvResult CreateIntConverter(const PvString &aValueFeatureName, const PvString &aFromFormula, const PvString &aToFormula)=0
Adds an integer Converter to the GenICam XML file using the current state of the factory for its attr...
virtual void SetRepresentation(PvGenRepresentation aRepresentation)=0
Sets the numeric representation of the next feature to be added to the GenICam XML file.
virtual void AddVariable(const PvString &aFeatureName)=0
Adds a variable that will be declared for the next SwissKnife of Converter to be added to the GenICam...
virtual void SetCachable(PvGenCache aCache)=0
Sets the cache behavior of the next feature to be added to the GenICam XML file.
virtual void SetVisibility(PvGenVisibility aVisibility)=0
Sets the visibility of the next feature to be added to the GenICam XML.
virtual PvResult CreateFloat(IPvRegister *aRegister, double aMin, double aMax)=0
Adds a float feature to the GenICam XML file using the current state of the factory for its attribute...
virtual void AddSelected(const PvString &aFeatureName)=0
Adds a selector to the next feature to be added to the GenICam XML file.
virtual void MapEvent(uint32_t aEventID, uint32_t aAddress, size_t aLength, PvGenEndianness aEndianness=PvGenEndiannessLittle, bool aAdjustAddress=true)=0
Maps the next feature to be added to the GenICam XML file to a messaging channel event,...
virtual void SetCategory(const PvString &aCategory)=0
Sets the category of the next feature to be added to the GenICam XML file.
virtual PvResult CreateIntSwissKnife(const PvString &aFormula)=0
Adds an integer SwissKnife to the GenICam XML file using the current state of the factory for its att...
virtual PvResult CreateString(IPvRegister *aRegister=NULL)=0
Adds a string feature to the GenICam XML file using the current state of the factory for its attribut...
virtual void SetStreamable(bool aStreamable)=0
Sets the streamable behaviour of the next feature to be added to the GenICam XML.
virtual void SetPInc(const PvString &aFeatureName)=0
Sets node to use for integer dynamic increment attribute.
virtual void SetPMin(const PvString &aFeatureName)=0
Sets node to use for integer or float dynamic minimum attribute.
virtual void SetAccessMode(PvGenAccessMode aAccessMode)=0
Sets the access mode of the next feature to be added to the GenICam XML file.
virtual void SetPollingTime(uint32_t aPollingTime)=0
Sets the polling time, in ms, of the next feature to be added to the GenICam XML file.
virtual void AddEnumEntry(const PvString &aName, uint32_t aValue, const PvString &aDisplayName, PvGenNameSpace aNameSpace=PvGenNameSpaceCustom)=0
Add an enumeration entry to the next feature to be added to the GenICam XML file.
virtual PvResult SetPMinFor(const PvString &aStandardFeatureName, const PvString &aPMinFeatureName)=0
Forces a pMin reference for an integer or float feature managed by PvSoftDeviceGEV.
virtual ~IPvGenApiFactory()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:1998
virtual void SetNameSpace(PvGenNameSpace aNameSpace)=0
Sets the namespace of the next feature to be added to the GenICam XML file.
virtual PvResult CreateEnum(IPvRegister *aRegister=NULL)=0
Adds an enumeration feature to the GenICam XML file using the current state of the factory for its at...
virtual void SetPValue(const PvString &aFeatureName)=0
Sets the pValue attribute of the next feature to be added to the GenICam XML.
virtual void AddInvalidator(const PvString &aFeatureName)=0
Add an invalidator to the next feature to be added to the GenICam XML file.
virtual void AddEnumEntry(const PvString &aName, uint32_t aValue)=0
Add an enumeration entry to the next feature to be added to the GenICam XML file.
virtual PvResult SetPIsAvailableFor(const PvString &aStandardFeatureName, const PvString &aPIsAvailableFeatureName)=0
Forces a pIsAvailable reference for a feature managed by PvSoftDeviceGEV.
virtual PvResult SetPIncFor(const PvString &aStandardFeatureName, const PvString &aPIncFeatureName)=0
Forces a pInc reference for an integer feature managed by PvSoftDeviceGEV.
virtual void SetUnit(const PvString &aUnit)=0
Sets the units for an integer or float feature.
virtual void SetToolTip(const PvString &aToolTip)=0
Sets the tooltip of the next feature to be added to the GenICam XML file.
virtual PvResult CreateBoolean(IPvRegister *aRegister=NULL)=0
Adds a Boolean feature to the GenICam XML file using the current state of the factory for its attribu...
virtual void MapChunk(uint32_t aChunkID, uint32_t aAddress, size_t aLength, PvGenEndianness aEndianness=PvGenEndiannessLittle)=0
Maps the next feature to be added to the GenICam XML file to a chunk, identified by its ID.
virtual void SetPIsAvailable(const PvString &aFeatureName)=0
Sets the pIsAvaialble attribute of the next feature to be added to the GenICam XML.
virtual PvResult SetPMaxFor(const PvString &aStandardFeatureName, const PvString &aPMaxFeatureName)=0
Forces a pMax reference for an integer or float feature managed by PvSoftDeviceGEV.
virtual PvResult CreateInteger(IPvRegister *aRegister, int64_t aMin, int64_t aMax, int64_t aInc=1)=0
Adds an integer feature to the GenICam XML file using the current state of the factory for its attrib...
virtual void SetTLLocked(bool aLocked)=0
Sets the TLParamsLocked behavior of the next feature to be added to the GenICam XML file.
virtual void SetName(const PvString &aName)=0
Sets the name of the next feature to be added to the GenICam XML file.
virtual PvResult CreateCommand(IPvRegister *aRegister=NULL)=0
Adds a command feature to the GenICam XML file using the current state of the factory for its attribu...
Messaging channel interface of the software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:478
virtual PvResult FireEvent(uint16_t aEventID, uint64_t aBlockID=0, uint16_t aChannelIndex=0xFFFF)=0
Fires a messaging channel event.
virtual bool IsOpened()=0
Indicates whether the messaging channel is open.
virtual PvResult FireEvent(uint16_t aEventID, uint8_t *aData, uint32_t aDataLength, uint64_t aBlockID=0, uint16_t aChannelIndex=0xFFFF)=0
Fires a messaging channel event.
virtual ~IPvMessageChannel()
Destructor.
Definition: PvSoftDeviceGEVInterfaces.h:484
Interface that is used to report the register activity of the software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:1700
virtual PvResult PreWrite(IPvRegister *aRegister)
Pre-write register notification.
Definition: PvSoftDeviceGEVInterfaces.h:1766
virtual void PostWrite(IPvRegister *aRegister)
Post-write register notification.
Definition: PvSoftDeviceGEVInterfaces.h:1779
virtual void PostRead(IPvRegister *aRegister)
Post-read register notification.
Definition: PvSoftDeviceGEVInterfaces.h:1738
virtual ~IPvRegisterEventSink()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:1706
virtual PvResult Persist(IPvRegister *aRegister, IPvRegisterStore *aStore)
Peristence request for selected registers for user-sets.
Definition: PvSoftDeviceGEVInterfaces.h:1807
virtual PvResult PreRead(IPvRegister *aRegister)
Pre-read register notification.
Definition: PvSoftDeviceGEVInterfaces.h:1729
Class used for register creation.
Definition: PvSoftDeviceGEVInterfaces.h:1821
virtual PvResult AddByteArray(const PvString &aName, uint32_t aAddress, uint32_t aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSink *aRegisterEventSink=NULL, void *aContext=NULL)=0
Adds a new array of bytes (String, Register) to the PvSoftDeviceGEV register map.
virtual PvResult AddRegister(const PvString &aName, uint32_t aAddress, uint32_t aLength, PvGenAccessMode aAccessMode, IPvRegisterEventSink *aRegisterEventSink=NULL, void *aContext=NULL)=0
Adds a new register (Integer, Float) to the PvSoftDeviceGEV register map.
virtual ~IPvRegisterFactory()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:1827
Interface that is used to access the registers of the software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:1470
virtual ~IPvRegister()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:1476
virtual PvResult Read(uint32_t &aValue, uint32_t aOffset=0)=0
Reads the register content to a 4-byte unsigned integer.
virtual PvResult ReadDouble(double &aValue)=0
Reads the register content to a double precision floating point.
virtual PvResult Read(PvString &aValue)=0
Reads the register content to a string.
virtual PvResult AddEventSink(IPvRegisterEventSink *aEventSink)=0
Registers a IPvRegisterEventSink for register callbacks.
virtual PvResult Read(uint8_t *aData, uint32_t aByteCount, uint32_t aOffset=0)=0
Reads a register to an array of bytes.
virtual PvResult Write(const uint8_t *aData, uint32_t aByteCount, uint32_t aOffset=0)=0
Writes an array of bytes to a register.
virtual PvResult Write(uint32_t aValue, uint32_t aOffset=0)=0
Writes the register content from a 4-byte unsigned integer.
virtual PvResult RemoveEventSink(IPvRegisterEventSink *aEventSink)=0
Removes an event sink registered with AddEventSink.
virtual PvResult WriteFloat(float aValue)=0
Writes the register content from a float.
virtual PvResult WriteDouble(double aValue)=0
Writes the register content from a double precision floating point.
virtual PvResult Write(const PvString &aValue)=0
Writes the register content from a string.
virtual PvResult ReadFloat(float &aValue)=0
Reads the register content to a 4-byte float.
Interface to access basic information about a PvSoftDeviceGEV register.
Definition: PvSoftDeviceGEVInterfaces.h:1376
virtual const void * GetContext() const =0
Returns the contextual pointer provided at register creation.
virtual bool IsWritable() const =0
Indicates whether the register is writable.
virtual uint32_t GetAddress() const =0
Returns the register address.
virtual bool IsArrayOfBytes() const =0
Indicates whether the register is an array of bytes or plain data type.
virtual ~IPvRegisterInfo()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:1382
virtual size_t GetLength() const =0
Returns the length of the register, in bytes.
virtual void * GetContext()=0
Returns the contextual pointer provided at register creation.
virtual bool IsReadable() const =0
Indicates whether the register is readable.
virtual const PvString & GetName()=0
Returns the register name.
Register map interface for a software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:1877
virtual size_t GetRegisterCount()=0
Obtains a count of how many registers are in the PvSoftDeviceGEV register map.
virtual void Release()=0
Releases a lock acquired with Lock.
virtual PvResult Lock(uint32_t aTimeout)=0
Locks the register map for safe register access but fails on timeout.
virtual IPvRegister * GetRegisterByAddress(uint32_t aAddress)=0
Obtains a register from the register map based on the register's address.
virtual IPvRegister * GetRegisterByIndex(size_t aIndex)=0
Obtains a register from the register map based on the register's index.
virtual ~IPvRegisterMap()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:1883
virtual PvResult Lock()=0
Locks the register map for safe register access.
Class used with register persistence in the context of user-sets.
Definition: PvSoftDeviceGEVInterfaces.h:1658
virtual PvResult Persist(IPvRegister *aRegister, const PvString &aNameSuffix)=0
Persists a register to the register store using a name suffix.
Interface that is used by PvSoftDeviceGEV to report internal events.
Definition: PvSoftDeviceGEVInterfaces.h:571
virtual void OnDeviceResetFull(IPvSoftDeviceGEV *aDevice)
Notification that the PvSoftDeviceGEV has performed a full reset.
Definition: PvSoftDeviceGEVInterfaces.h:643
virtual void OnCreateCustomGenApiFeatures(IPvSoftDeviceGEV *aDevice, IPvGenApiFactory *aFactory)
Notification that the PvSoftDeviceGEV should create its custom GenApi parameters, if they are needed.
Definition: PvSoftDeviceGEVInterfaces.h:685
virtual void OnDeviceResetNetwork(IPvSoftDeviceGEV *aDevice)
Notification that the PvSoftDeviceGEV has reset its network stack.
Definition: PvSoftDeviceGEVInterfaces.h:653
virtual void OnApplicationDisconnect(IPvSoftDeviceGEV *aDevice)
Notification that the GigE Vision controller has released the control channel of the PvSoftDeviceGEV.
Definition: PvSoftDeviceGEVInterfaces.h:625
virtual void OnControlChannelStop(IPvSoftDeviceGEV *aDevice)
Notification that the control channel of the PvSoftDeviceGEV has been stopped.
Definition: PvSoftDeviceGEVInterfaces.h:634
virtual void OnControlChannelStart(IPvSoftDeviceGEV *aDevice, const PvString &aMACAddress, const PvString &aIPAddress, const PvString &aMask, const PvString &aGateway, uint16_t aPort)
Notification that the control channel of the PvSoftDeviceGEV has been started.
Definition: PvSoftDeviceGEVInterfaces.h:607
virtual ~IPvSoftDeviceGEVEventSink()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:577
virtual void OnCreateCustomRegisters(IPvSoftDeviceGEV *aDevice, IPvRegisterFactory *aFactory)
Notification that the PvSoftDeviceGEV should create its custom registers, if they are needed.
Definition: PvSoftDeviceGEVInterfaces.h:669
virtual void OnApplicationConnect(IPvSoftDeviceGEV *aDevice, const PvString &aIPAddress, uint16_t aPort, PvAccessType aAccessType)
Notification that a GigE Vision controller has taken ownership of the control channel of your PvSoftD...
Definition: PvSoftDeviceGEVInterfaces.h:587
Interface to the main class of the software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:2803
virtual PvResult AddStream(IPvStreamingChannelSource *aSource)=0
Adds a new stream to the PvSoftDeviceGEV.
virtual IPvSoftDeviceGEVStatistics * GetStatistics()=0
Obtains the statistics interface of the PvSoftDeviceGEV.
virtual IPvSoftDeviceGEVInfo * GetInfo()=0
Obtains the information interface of the PvSoftDeviceGEV.
virtual PvResult RegisterEventSink(IPvSoftDeviceGEVEventSink *aEventSink)=0
Registers an event sink to receive notifications from the PvSoftDeviceGEV.
virtual PvResult SetUserSetCount(uint32_t aCount)=0
Sets the number of user-sets supported by the PvSoftDeviceGEV.
virtual ~IPvSoftDeviceGEV()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:2809
virtual PvResult SetUserSetNotify(IPvUserSetNotify *aUserSetNotify)=0
Binds in a class which will contain a callback which will be called when the state of a UsersetLoad/S...
virtual IPvRegisterMap * GetRegisterMap()=0
Obtains the register map interface of the PvSoftDeviceGEV.
virtual PvResult GetGenICamXMLFile(PvString &aString) const =0
Returns the GenICam XML file of the device.
virtual PvResult SetTCPTransportEnabled(bool aEnabled)=0
Enables experimental TCP transport.
virtual PvResult SetRTPProtocolEnabled(bool aEnabled)=0
Enables the option of using RTP for streaming.
virtual PvResult UnregisterEventSink(IPvSoftDeviceGEVEventSink *aEventSink)=0
Unregisters a previously registered event sink.
virtual IPvMessageChannel * GetMessagingChannel()=0
Obtains the messaging channel interface of the PvSoftDeviceGEV.
virtual PvResult Stop()=0
Stops the PvSoftDeviceGEV.
virtual PvResult SetActionHandler(PvVirtualDeviceLib::IActionHandler *aActionHandler)=0
virtual PvResult Start(const PvString &aIpAddress)=0
Starts the PvSoftDeviceGEV.
Interface that is used to customize the identity of a software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:70
virtual PvResult SetGenICamXMLVersion(uint16_t aMajor, uint16_t aMinor, uint16_t aSubMinor)=0
Sets the GenICam XML file version.
virtual const PvString & GetDeviceVersion()=0
Returns the current PvSoftDeviceGEV version string.
virtual ~IPvSoftDeviceGEVInfo()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:76
virtual const PvString & GetManufacturerInformation()=0
Returns the current manufacturer information string.
virtual const PvString & GetSerialNumber()=0
Returns the current serial number string.
virtual PvResult SetDeviceVersion(const PvString &aValue)=0
Updates the device version string.
virtual uint16_t GetGenICamXMLVersionSubMinor() const =0
Returns the GenICam XML file subminor version.
virtual const PvString & GetManufacturerName()=0
Returns the current manufacturer name.
virtual PvResult SetGenICamXMLGUIDs(const PvString &aProduct, const PvString &aVersion)=0
Sets the GenICam XML file version.
virtual const PvString & GetGenICamXMLVersionGUID()=0
Returns the GenICam XML file Version GUID.
virtual PvResult SetSerialNumber(const PvString &aValue)=0
Updates the serial number string.
virtual const PvString & GetDeviceFirmwareVersion()=0
Returns the current PvSoftDeviceGEV firmware version string.
virtual PvResult SetModelName(const PvString &aValue)=0
Updates the model name string.
virtual PvResult SetDeviceFirmwareVersion(const PvString &aValue)=0
Updates the device firmware version string.
virtual const PvString & GetModelName()=0
Returns the current model name.
virtual uint16_t GetGenICamXMLVersionMinor() const =0
Returns the GenICam XML file minor version.
virtual PvResult SetManufacturerInformation(const PvString &aValue)=0
Updates the manufacturer information string.
virtual uint16_t GetGenICamXMLVersionMajor() const =0
Returns the GenICam XML file major version.
virtual PvResult SetManufacturerName(const PvString &aValue)=0
Updates the manufacturer name string.
virtual const PvString & GetGenICamXMLProductGUID()=0
Returns the GenICam XML file Product GUID.
Interface that is used to retrieve control channel statistics from a software-based GigE Vision Devic...
Definition: PvSoftDeviceGEVInterfaces.h:317
virtual uint64_t GetEventRetriesIssuedMax() const =0
virtual uint64_t GetRetriesReceived() const =0
GVCP command retries received.
virtual uint64_t GetForceIpsReceived() const =0
GVCP force IP configuration (FORCEIP_CMD) commands received.
virtual uint64_t GetSessionsOpened() const =0
Returns the device controller session open count.
virtual uint64_t GetReadRegsReceived() const =0
GVCP read register (READREG_CMD) commands received.
virtual uint64_t GetRetriesReceivedMax() const =0
GVCP command retries maximum for a single command.
virtual uint64_t GetDiscoveriesReceived() const =0
GVCP discovery (DISCOVERY_CMD) commands received.
virtual uint64_t GetEventRetriesIssued() const =0
GVCP retries issued for unacknowledged messaging channel event or event data commands.
virtual uint64_t GetWriteMemsReceived() const =0
GVCP write memory (WRITEMEM_CMD) commands received.
virtual uint64_t GetEventDatasIssued() const =0
GVCP messaging channel event (with data) comands (EVENTDATA_CMD) issued.
virtual uint64_t GetWriteRegsReceived() const =0
GVCP write register (WRITEREG_CMD) commands received.
virtual uint64_t GetPacketResendRequestsReceived() const =0
GVCP packet resend (PACKETRESEND_CMD) commands received.
virtual void Reset()=0
Resets all counters to zero.
virtual uint64_t GetGVSPTestPacketsIssued() const =0
Returns the number of GVSP test packets issued.
virtual uint64_t GetSessionsClosed() const =0
Returns the device controller session close count.
virtual uint64_t GetActionCommandsReceived() const =0
GVCP action command (ACTION_CMD) received.
virtual ~IPvSoftDeviceGEVStatistics()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:323
virtual uint64_t GetPendingAcksIssued() const =0
GVCP pending acknowledges (PENDING_ACK) issued.
virtual uint64_t GetEventsIssued() const =0
GVCP messaging channel event commands (EVENT_CMD) issued.
virtual uint64_t GetReadMemsReceived() const =0
GVCP read memory (READMEM_CMD) commands received.
virtual uint64_t GetHeartbeatFailedCount() const =0
Returns the device controller session close on heartbeat failure count.
Interface that is used by PvSoftDeviceGEV to query and report information from a streaming source imp...
Definition: PvSoftDeviceGEVInterfaces.h:739
virtual ~IPvStreamingChannelSource()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:745
virtual PvResult SetTestPayloadFormatMode(PvPayloadType aPayloadType)
When called, the streaming source has to ensure it can stream buffers of the specified payload type.
Definition: PvSoftDeviceGEVInterfaces.h:1362
virtual void SetMultiPartAllowed(bool aAllowed)
Sets whether the streaming source is allowed or not, but not forced, to transmit multi-part data.
Definition: PvSoftDeviceGEVInterfaces.h:1304
virtual PvPixelType GetPixelType() const =0
Returns the current pixel type.
virtual void SetLargeLeaderTrailerEnabled(bool aEnabled, uint32_t aMaxMultiPartCount)
Sets whether the streaming source which transmit multi-part data uses large data leader and trailer p...
Definition: PvSoftDeviceGEVInterfaces.h:1321
virtual void FreeBuffer(PvBuffer *aBuffer)=0
Request by the PvSoftDeviceGEV to free or release a buffer allocated with AllocBuffer.
virtual bool PreQueueBufferProc()
Definition: PvSoftDeviceGEVInterfaces.h:1141
virtual void PostRetrieveBufferProc()
Definition: PvSoftDeviceGEVInterfaces.h:1148
virtual uint32_t GetOffsetX() const =0
Returns the current image offset X.
virtual uint32_t GetPayloadSize() const =0
Stream channel payload size in bytes. Return zero to have it inferred from width, height and pixel fo...
virtual PvResult SetWidth(uint32_t aWidth)=0
Request from the PvSoftDeviceGEV to change the image width.
virtual PvResult SetOffsetX(uint32_t aOffsetX)=0
Request from the PvSoftDeviceGEV to change the image offset X.
virtual void CreateRegisters(IPvRegisterMap *aRegisterMap, IPvRegisterFactory *aFactory)
When called, the streaming channel source should create its custom registers if they are needed.
Definition: PvSoftDeviceGEVInterfaces.h:1199
virtual void GetWidthInfo(uint32_t &aMin, uint32_t &aMax, uint32_t &aInc) const =0
Returns the stream channel width attributes.
virtual PvResult GetSupportedChunk(int aIndex, uint32_t &aID, PvString &aName) const =0
Returns the indexed supported chunk type. Used at PvSoftDeviceGEV::Start time to create the GenICam X...
virtual void OnOpen(const PvString &aDestIP, uint16_t aDestPort)=0
Notification from the PvSoftDeviceGEV that this streaming channel has been opened.
virtual PvResult SetChunkModeActive(bool aEnabled)=0
Set the master chunk mode active state.
virtual void OnStreamingStart()=0
Notification that the GigE Vision controller has requested that the device start streaming on this ch...
virtual uint32_t GetWidth() const =0
Returns the current image width.
virtual PvResult RetrieveBuffer(PvBuffer **aBuffer)=0
Request by the PvSoftDeviceGEV to retrieve a buffer from the streaming source.
virtual PvBuffer * AllocBuffer()=0
Request by the PvSoftDeviceGEV to allocate a PvBuffer.
virtual PvResult SetPixelType(PvPixelType aPixelType)=0
Request from the PvSoftDeviceGEV to change the image pixel type.
virtual PvResult SetHeight(uint32_t aHeight)=0
Request from the PvSoftDeviceGEV to change the image height.
virtual PvScanType GetScanType() const =0
Returns the scan type that is used by the streaming source.
virtual PvResult SetOffsetY(uint32_t aOffsetY)=0
Request from the PvSoftDeviceGEV to change the image offset Y.
virtual uint32_t GetHeight() const =0
Returns the current image height.
virtual void CreateGenApiFeatures(IPvRegisterMap *aRegisterMap, IPvGenApiFactory *aFactory)
When called, the streaming channel source should create its custom GenApi parameters if they are need...
Definition: PvSoftDeviceGEVInterfaces.h:1265
virtual PvResult GetSupportedPixelType(int aIndex, PvPixelType &aPixelType) const =0
Obtains an index of supported pixel types. Used at PvSoftDeviceGEV::Start time to create the GenICam ...
virtual void OnStreamingStop()=0
Notification that the GigE Vision controller has requested that the device stop streaming on this cha...
virtual PvResult QueueBuffer(PvBuffer *aBuffer)=0
Request by the PvSoftDeviceGEV to queue a buffer for acquisition.
virtual uint32_t GetOffsetY() const =0
Returns the current image offset Y.
virtual uint32_t GetChunksSize() const =0
Gets the stream channel chunk size attributes.
virtual bool GetChunkEnable(uint32_t aChunkID) const =0
Returns the current chunk enabled state.
virtual void GetHeightInfo(uint32_t &aMin, uint32_t &aMax, uint32_t &aInc) const =0
Returns the stream channel height attributes.
virtual void AbortQueuedBuffers()=0
Request by the PvSoftDeviceGEV to abort all buffers queued for acquisition.
virtual PvResult SetChunkEnable(uint32_t aChunkID, bool aEnabled)=0
Sets the chunk enabled state for a specific chunk type.
virtual bool IsPayloadTypeSupported(PvPayloadType aPayloadType)
When called, the streaming source has to return whether the specificed payload type is supported or n...
Definition: PvSoftDeviceGEVInterfaces.h:1286
virtual void OnClose()=0
Notification from the PvSoftDeviceGEV that this streaming channel has been closed.
virtual bool GetChunkModeActive() const =0
Indicates whether the current master chunk mode is active.
An interface to register a state change callback for UserSets.
Definition: IPvUserSetNotify.h:46
Represents a block of GigE Vision or USB3 Vision data in memory.
Definition: PvBuffer.h:97
Result information.
Definition: PvResult.h:30
String class.
Definition: PvString.h:26
@ OK
Definition: PvResult.h:502
@ NOT_SUPPORTED
Definition: PvResult.h:522
@ NOT_IMPLEMENTED
Definition: PvResult.h:521
eBUS SDK v6.4.0.6670 API