Class PvConfigurationReader

Reads and restores configuration data from persistence files.

Inheritance

object

PvConfigurationReader

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

Remarks

This class provides methods to load configuration data and restore it to devices, streams, parameter arrays, and property lists.

Constructors

PvConfigurationReader()

Constructor.

Declaration

public PvConfigurationReader()

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

DeviceCount

Returns the number of devices stored in the configuration.

Declaration

public uint DeviceCount { get; }

Property Value

Type	Description
uint

GenParameterArrayCount

Returns the number of GenICam parameter arrays stored in the configuration.

Declaration

public uint GenParameterArrayCount { get; }

Property Value

Type	Description
uint

PropertyListCount

Returns the number of property lists stored in the configuration.

Declaration

public uint PropertyListCount { get; }

Property Value

Type	Description
uint

StreamCount

Returns the number of streams stored in the configuration.

Declaration

public uint StreamCount { get; }

Property Value

Type	Description
uint

StringCount

Returns the number of strings stored in the configuration.

Declaration

public uint StringCount { get; }

Property Value

Type	Description
uint

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvConfigurationReader()

Destructor.

Declaration

protected ~PvConfigurationReader()

GetDeviceName(uint, out string)

Gets the name of a device at the specified index.

Declaration

public PvResult GetDeviceName(uint aIndex, out string aName)

Parameters

Type	Name	Description
uint	aIndex	Index of the device.
string	aName	Name of the device.

Returns

Type	Description
PvResult	Result of the operation.

GetGenParameterArrayName(uint, out string)

Gets the name of a GenICam parameter array at the specified index.

Declaration

public PvResult GetGenParameterArrayName(uint aIndex, out string aName)

Parameters

Type	Name	Description
uint	aIndex	Index of the parameter array.
string	aName	Name of the parameter array.

Returns

Type	Description
PvResult	Result of the operation.

GetPropertyListName(uint, out string)

Gets the name of a property list at the specified index.

Declaration

public PvResult GetPropertyListName(uint aIndex, out string aName)

Parameters

Type	Name	Description
uint	aIndex	Index of the property list.
string	aName	Name of the property list.

Returns

Type	Description
PvResult	Result of the operation.

GetStreamName(uint, out string)

Gets the name of a stream at the specified index.

Declaration

public PvResult GetStreamName(uint aIndex, out string aName)

Parameters

Type	Name	Description
uint	aIndex	Index of the stream.
string	aName	Name of the stream.

Returns

Type	Description
PvResult	Result of the operation.

GetStringName(uint, out string)

Gets the name of a string entry at the specified index.

Declaration

public PvResult GetStringName(uint aIndex, out string aName)

Parameters

Type	Name	Description
uint	aIndex	Index of the string entry.
string	aName	Name of the string entry.

Returns

Type	Description
PvResult	Result of the operation.

Load(string)

Loads configuration data from a file.

Declaration

public PvResult Load(string aFilename)

Parameters

Type	Name	Description
string	aFilename	Path to the configuration file.

Returns

Type	Description
PvResult	Result of the operation.

LoadFromString(string)

Loads configuration data from a string.

Declaration

public PvResult LoadFromString(string aString)

Parameters

Type	Name	Description
string	aString	String containing the configuration data.

Returns

Type	Description
PvResult	Result of the operation.

Restore(string, ref PvDevice)

Restores configuration to a device by name.

Declaration

public PvResult Restore(string aName, ref PvDevice aDevice)

Parameters

Type	Name	Description
string	aName	Name of the stored device configuration.
PvDevice	aDevice	Device to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(string, ref PvGenParameterArray)

Restores configuration to a GenICam parameter array by key.

Declaration

public PvResult Restore(string aKey, ref PvGenParameterArray aParameterArray)

Parameters

Type	Name	Description
string	aKey	Key of the stored parameter array configuration.
PvGenParameterArray	aParameterArray	Parameter array to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(string, ref PvPropertyList)

Restores configuration to a property list by key.

Declaration

public PvResult Restore(string aKey, ref PvPropertyList aPropertyList)

Parameters

Type	Name	Description
string	aKey	Key of the stored property list configuration.
PvPropertyList	aPropertyList	Property list to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(string, ref PvStream)

Restores configuration to a stream by name.

Declaration

public PvResult Restore(string aName, ref PvStream aStream)

Parameters

Type	Name	Description
string	aName	Name of the stored stream configuration.
PvStream	aStream	Stream to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(string, out string)

Restores a string value by key.

Declaration

public PvResult Restore(string aKey, out string aValue)

Parameters

Type	Name	Description
string	aKey	Key of the stored string.
string	aValue	Restored string value.

Returns

Type	Description
PvResult	Result of the operation.

Restore(uint, ref PvDevice)

Restores configuration to a device by index.

Declaration

public PvResult Restore(uint aIndex, ref PvDevice aDevice)

Parameters

Type	Name	Description
uint	aIndex	Index of the stored device configuration.
PvDevice	aDevice	Device to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(uint, ref PvGenParameterArray)

Restores configuration to a GenICam parameter array by index.

Declaration

public PvResult Restore(uint aIndex, ref PvGenParameterArray aParameterArray)

Parameters

Type	Name	Description
uint	aIndex	Index of the stored parameter array configuration.
PvGenParameterArray	aParameterArray	Parameter array to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(uint, ref PvPropertyList)

Restores configuration to a property list by index.

Declaration

public PvResult Restore(uint aIndex, ref PvPropertyList aPropertyList)

Parameters

Type	Name	Description
uint	aIndex	Index of the stored property list configuration.
PvPropertyList	aPropertyList	Property list to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(uint, PvStream)

Restores configuration to a stream by index.

Declaration

public PvResult Restore(uint aIndex, PvStream Stream)

Parameters

Type	Name	Description
uint	aIndex	Index of the stored stream configuration.
PvStream	Stream	Stream to restore configuration to.

Returns

Type	Description
PvResult	Result of the operation.

Restore(uint, out string)

Restores a string value by index.

Declaration

public PvResult Restore(uint aIndex, out string aValue)

Parameters

Type	Name	Description
uint	aIndex	Index of the stored string.
string	aValue	Restored string value.

Returns

Type	Description
PvResult	Result of the operation.

SetErrorList(SWIGTYPE_p_PvStringList, string)

Sets the error list for collecting error messages during restore 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.

Implements

IDisposable