Class PvConfigurationWriter

Writes configuration data to persistence files.

Inheritance

object

PvConfigurationWriter

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

Remarks

This class provides methods to store configuration from devices, streams, parameter arrays, and property lists, then save to files or strings.

Constructors

View Source

PvConfigurationWriter()

Constructor.

Declaration

public PvConfigurationWriter()

Fields

View Source

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Methods

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

~PvConfigurationWriter()

Destructor.

Declaration

protected ~PvConfigurationWriter()

View Source

Save(string)

Saves the configuration to a file.

Declaration

public PvResult Save(string aFilename)

Parameters

Type	Name	Description
string	aFilename	Path to the output file.

Returns

Type	Description
PvResult	Result of the operation.

View Source

SaveToString(out string)

Saves the configuration to a string.

Declaration

public PvResult SaveToString(out string aString)

Parameters

Type	Name	Description
string	aString	String to receive the configuration data.

Returns

Type	Description
PvResult	Result of the operation.

View Source

SetErrorList(SWIGTYPE_p_PvStringList, string)

Sets the error list for collecting error messages during store operations.

Declaration

public void SetErrorList(SWIGTYPE_p_PvStringList aList, string aPrefix)

Parameters

Type	Name	Description
SWIGTYPE_p_PvStringList	aList	String list to receive error messages.
string	aPrefix	Prefix to add to error messages.

View Source

Store(ref PvDevice)

Stores configuration from a device.

Declaration

public PvResult Store(ref PvDevice aDevice)

Parameters

Type	Name	Description
PvDevice	aDevice	Device to store configuration from.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(ref PvDevice, string)

Stores configuration from a device.

Declaration

public PvResult Store(ref PvDevice aDevice, string aName)

Parameters

Type	Name	Description
PvDevice	aDevice	Device to store configuration from.
string	aName	Optional name for the stored configuration.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(PvGenParameterArray)

Stores configuration from a GenICam parameter array.

Declaration

public PvResult Store(PvGenParameterArray aGenParameterArray)

Parameters

Type	Name	Description
PvGenParameterArray	aGenParameterArray	Parameter array to store configuration from.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(PvGenParameterArray, string)

Stores configuration from a GenICam parameter array.

Declaration

public PvResult Store(PvGenParameterArray aGenParameterArray, string aName)

Parameters

Type	Name	Description
PvGenParameterArray	aGenParameterArray	Parameter array to store configuration from.
string	aName	Optional name for the stored configuration.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(PvGenParameterArray, string, SWIGTYPE_p_PvStringList)

Stores configuration from a GenICam parameter array.

Declaration

public PvResult Store(PvGenParameterArray aGenParameterArray, string aName, SWIGTYPE_p_PvStringList aExtendedBlackList)

Parameters

Type	Name	Description
PvGenParameterArray	aGenParameterArray	Parameter array to store configuration from.
string	aName	Optional name for the stored configuration.
SWIGTYPE_p_PvStringList	aExtendedBlackList	Optional list of parameter names to exclude from storage.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(ref PvPropertyList)

Stores a property list.

Declaration

public PvResult Store(ref PvPropertyList aPropertyList)

Parameters

Type	Name	Description
PvPropertyList	aPropertyList	Property list to store.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(ref PvPropertyList, string)

Stores a property list.

Declaration

public PvResult Store(ref PvPropertyList aPropertyList, string aName)

Parameters

Type	Name	Description
PvPropertyList	aPropertyList	Property list to store.
string	aName	Optional name for the stored configuration.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(ref PvStream)

Stores configuration from a stream.

Declaration

public PvResult Store(ref PvStream aStream)

Parameters

Type	Name	Description
PvStream	aStream	Stream to store configuration from.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(ref PvStream, string)

Stores configuration from a stream.

Declaration

public PvResult Store(ref PvStream aStream, string aName)

Parameters

Type	Name	Description
PvStream	aStream	Stream to store configuration from.
string	aName	Optional name for the stored configuration.

Returns

Type	Description
PvResult	Result of the operation.

View Source

Store(string, string)

Stores a string value.

Declaration

public PvResult Store(string aString, string aName)

Parameters

Type	Name	Description
string	aString	String value to store.
string	aName	Name/key for the stored string.

Returns

Type	Description
PvResult	Result of the operation.

Implements

IDisposable