Class PvAcquisitionStateManager

Acquisition state manager, advanced TLParamsLocked manager.

Inheritance

object

PvAcquisitionStateManager

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class PvAcquisitionStateManager : IDisposable

Remarks

Contains logic to manage the TLParamsLocked GenICam parameter of a PvDevice over various acquisition modes.

A PvDevice is provided to the constructor of this class. A PvStream is also 
usually provided. The Start and Stop methods are invoked to start and stop
the acquisition. If a stream is not provided, the acquisition state has 
to be reset manually for some acquisition mode as incoming buffers
cannot be reported/counted.

It takes control of issuing Start/Stop methods to the AcquisitionStart and
AcquisitionStop GenICam commands of a device. It also counts frames (when applicable)
to automatically release TLParamsLocked when all the buffers have been accounted
for. It is possible to cancel the operation preemptively by calling Stop - if the
user wants to cancel the operation or the user knows some buffers were lost and will
never come.

Constructors

PvAcquisitionStateManager(PvDevice)

Constructor.

Declaration

public PvAcquisitionStateManager(PvDevice aDevice)

Parameters

Type	Name	Description
PvDevice	aDevice	Pointer to the PvDevice acquisition controller.

PvAcquisitionStateManager(PvDevice, PvStream)

Constructor.

Declaration

public PvAcquisitionStateManager(PvDevice aDevice, PvStream aStream)

Parameters

Type	Name	Description
PvDevice	aDevice	Pointer to the PvDevice acquisition controller.
PvStream	aStream	A pointer to a PvStream receiving buffers. Optional.

PvAcquisitionStateManager(PvDevice, PvStream, uint)

Constructor.

Declaration

public PvAcquisitionStateManager(PvDevice aDevice, PvStream aStream, uint aSource)

Parameters

Type	Name	Description
PvDevice	aDevice	Pointer to the PvDevice acquisition controller.
PvStream	aStream	A pointer to a PvStream receiving buffers. Optional.
uint	aSource	Index of the source in SourceSelector to use. Optional.

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

Source

Index of the active source.

Declaration

public virtual uint Source { get; }

Property Value

Type	Description
uint

State

Current acquisition state.

Declaration

public virtual PvAcquisitionState State { get; }

Property Value

Type	Description
PvAcquisitionState

Remarks

Returns the state of the acquisition (locked, unlocked, etc.).

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvAcquisitionStateManager()

Destructor.

Declaration

protected ~PvAcquisitionStateManager()

RegisterEventSink(PvAcquisitionStateEventSink)

Register an event sink used for callbacks.

Declaration

public PvResult RegisterEventSink(PvAcquisitionStateEventSink aEventSink)

Parameters

Type	Name	Description
PvAcquisitionStateEventSink	aEventSink	A pointer to the event sink.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER #PvResult::Code::GENERIC_ERROR

Start()

Starts the acquisition.

Declaration

public PvResult Start()

Returns

Type

Description

PvResult

Includes: #PvResult::Code::INVALID_PARAMETER if the PvDevice is not valid or there are issues with some of the GenICam parameters. #PvResult::Code::STATE_ERROR if TLParamsLocked is already set. #PvResult::Code::NOT_IMPLEMENTED if some critical GenICam parameters not not implemented in the device GenICam interface. #PvResult::Code::GENERIC_ERROR can be propagated up if issues are encountered accessing the parameters of the device GenICam interface.

Stop()

Stops acquisition.

Declaration

public PvResult Stop()

Returns

Type	Description
PvResult	Includes: #PvResult::Code::INVALID_PARAMETER if the PvDevice is not valid or there are issues with some of the GenICam parameters. #PvResult::Code::GENERIC_ERROR can be propagated up if issues are encountered accessing the parameters of the device GenICam interface.

UnregisterEventSink(PvAcquisitionStateEventSink)

Unregister an event sink

Declaration

public PvResult UnregisterEventSink(PvAcquisitionStateEventSink aEventSink)

Parameters

Type	Name	Description
PvAcquisitionStateEventSink	aEventSink	A pointer to the event sink.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER #PvResult::Code::NOT_FOUND

Events

OnAcquisitionStateChanged

Called whenever the state manager changes the acquisition mode.

Declaration

public event OnAcquisitionStateChanged OnAcquisitionStateChanged

Event Type

Type	Description
OnAcquisitionStateChanged

Implements

IDisposable