Class PvRawData

Raw data interface to a PvBuffer.

Inheritance
object
PvRawData
Implements
Inherited Members
Namespace: eBUSDotNet
Assembly: eBUSDotNet.dll
Syntax
public class PvRawData : IDisposable
Remarks

A PvBuffer represents a generic buffer with no specific payload type. If the payload type is raw data, the user can obtain a pointer to a PvRawData buffer interface through PvBuffer::GetRawData.

This PvRawData pointer is owned by the PvBuffer and does not need to be released
after use. It is valid as long as the PvBuffer exists.

Fields

View Source

swigCMemOwn

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

Declaration
protected bool swigCMemOwn
Field Value
Type Description
bool

Properties

View Source

PayloadLength

Payload length of PvRawData.

Declaration
public ulong PayloadLength { get; }
Property Value
Type Description
ulong

Methods

View Source

Alloc(ulong)

Allocates memory for this #PvRawData.

Declaration
public PvResult Alloc(ulong aPayloadLength)
Parameters
Type Name Description
ulong aPayloadLength

The payload length of the raw data, in pixels. See #GetPayloadLength.
Returns
Type Description
PvResult

Includes:

  • #PvResult::Code::OK
  • #PvResult::Code::NOT_ENOUGH_MEMORY
View Source

Alloc(ulong, uint)

Allocates memory for this #PvRawData.

Declaration
public PvResult Alloc(ulong aPayloadLength, uint aMaximumChunkLength)
Parameters
Type Name Description
ulong aPayloadLength

The payload length of the raw data, in pixels. See #GetPayloadLength.
uint aMaximumChunkLength

Maximum size in bytes to store chunks ( must include extra 64 bits by chunks for headers ).
Returns
Type Description
PvResult

Includes:

  • #PvResult::Code::OK
  • #PvResult::Code::NOT_ENOUGH_MEMORY
View Source

Attach(byte[], ulong)

Attach this #PvRawData to an external memory buffer.

Declaration
public PvResult Attach(byte[] aRawBuffer, ulong aPayloadLength)
Parameters
Type Name Description
byte[] aRawBuffer

A pointer to the buffer.
ulong aPayloadLength

The payload length of the raw data, in pixels. See #GetPayloadLength.
Returns
Type Description
PvResult

Includes:

  • #PvResult::Code::OK
  • #PvResult::Code::INVALID_PARAMETER
View Source

Attach(byte[], ulong, uint)

Attach this #PvRawData to an external memory buffer.

Declaration
public PvResult Attach(byte[] aRawBuffer, ulong aPayloadLength, uint aMaximumChunkLength)
Parameters
Type Name Description
byte[] aRawBuffer

A pointer to the buffer.
ulong aPayloadLength

The payload length of the raw data, in pixels. See #GetPayloadLength.
uint aMaximumChunkLength

See #Alloc(uint64_t,uint32_t).
Returns
Type Description
PvResult

Includes:

  • #PvResult::Code::OK
  • #PvResult::Code::INVALID_PARAMETER
View Source

Detach()

Releases an attached memory buffer.

Declaration
public virtual byte* Detach()
Returns
Type Description
byte*

The buffer's location in memory.
See Also
View Source

Dispose()

Dispose.

Declaration
public void Dispose()
View Source

Dispose(bool)

Dispose

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
View Source

~PvRawData()

Destructor.

Declaration
protected ~PvRawData()
View Source

Free()

Frees (de-allocates) the buffer's internal memory.

Declaration
public virtual void Free()
See Also

Implements