Class PvBufferWriter

Saves the contents of a PvBuffer object to a raw data file or bitmap.

Inheritance

object

PvBufferWriter

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 PvBufferWriter : IDisposable

Remarks

To save an image buffer to disk:

1. Acquire an image. See PvBuffer.
2. Create an image save. Use PvBufferWriter.PvBufferWriter.
3. Save the image to disk. Use Store( PvBuffer ^aBuffer, String ^aFilename, PvBufferFormatType aType ).

Constructors

PvBufferWriter()

Constructor.

Declaration

public PvBufferWriter()

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

Converter

Returns a reference to the internal buffer converter. When writing the buffer to a file requires a conversion, it is performed automatically by the PvBufferWriter.

Declaration

public PvBufferConverter Converter { get; }

Property Value

Type	Description
PvBufferConverter

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvBufferWriter()

Destructor.

Declaration

protected ~PvBufferWriter()

Store(PvBuffer, string)

Saves a #PvBuffer to disk.

Declaration

public PvResult Store(PvBuffer aBuffer, string aFilename)

Parameters

Type	Name	Description
PvBuffer	aBuffer	The image to save.
string	aFilename	The filename, including extension. The format uses the same standard as the C fopen function. In C/C++, valid filenames include "myfile.raw", "..\myfile.bmp", "C:\myfile.bmp".

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER (e.g. invalid PvBufferFormatType.) #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::INVALID_DATA_FORMAT (The buffer can't be converted to the specified type.)

Store(PvBuffer, string, PvBufferFormatType)

Saves a #PvBuffer to disk.

Declaration

public PvResult Store(PvBuffer aBuffer, string aFilename, PvBufferFormatType aType)

Parameters

Type	Name	Description
PvBuffer	aBuffer	The image to save.
string	aFilename	The filename, including extension. The format uses the same standard as the C fopen function. In C/C++, valid filenames include "myfile.raw", "..\myfile.bmp", "C:\myfile.bmp".
PvBufferFormatType	aType	The format of the image; a PvBufferFormatType enumeration.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER (e.g. invalid PvBufferFormatType.) #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::INVALID_DATA_FORMAT (The buffer can't be converted to the specified type.)

Store(PvBuffer, string, PvBufferFormatType, out uint)

Saves a #PvBuffer to disk.

Declaration

public PvResult Store(PvBuffer aBuffer, string aFilename, PvBufferFormatType aType, out uint aBytesWritten)

Parameters

Type	Name	Description
PvBuffer	aBuffer	The image to save.
string	aFilename	The filename, including extension. The format uses the same standard as the C fopen function. In C/C++, valid filenames include "myfile.raw", "..\myfile.bmp", "C:\myfile.bmp".
PvBufferFormatType	aType	The format of the image; a PvBufferFormatType enumeration.
uint	aBytesWritten	If not NULL (default) contains the number of bytes effectively written when storing the buffer.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::INVALID_PARAMETER (e.g. invalid PvBufferFormatType.) #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::INVALID_DATA_FORMAT (The buffer can't be converted to the specified type.)

Implements

IDisposable