Writes configuration data to persistence files. More...

#include <PvConfigurationWriter.h>

Public Member Functions
	PvConfigurationWriter ()
	Constructor.

	~PvConfigurationWriter ()
	Destructor.

PvResult	Store (PvDevice *aDevice, PvString aName=PvString(""))
	Stores configuration from a device. More...

PvResult	Store (PvStream *aStream, PvString aName=PvString(""))
	Stores configuration from a stream. More...

PvResult	Store (const PvString &aString, const PvString &aName)
	Stores a string value. More...

PvResult	Store (PvGenParameterArray aGenParameterArray, PvString aName=PvString(""), PvStringList aExtendedBlackList=NULL)
	Stores configuration from a GenICam parameter array. More...

PvResult	Store (PvPropertyList *aPropertyList, PvString aName=PvString(""))
	Stores a property list. More...

PvResult	Save (const PvString &aFilename)
	Saves the configuration to a file. More...

PvResult	SaveToString (PvString &aString)
	Saves the configuration to a string. More...

void	SetErrorList (PvStringList *aList, const PvString &aPrefix)
	Sets the error list for collecting error messages during store operations. More...

Detailed Description

Writes configuration data to persistence files.

Save the state of the system.

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

You can save:

the GigE Vision or USB3 Vision device's state (all streamable parameters)
the SDK's state (stream information and information needed to connect to a device)
your own custom strings and property lists

To save your state information:

Create a configuration writer. Use PvConfigurationWriter::PvConfigurationWriter.
Store state information in the configuration writer.
- For GigE Vision or USB3 Vision device controllers (PvDevice objects), use Store(PvDevice,PvString).
- For GigE Vision or USB3 Vision stream channel receivers (PvStream objects), use Store(PvStream,PvString).
Optionally, store your own state information. Use Store (PvString,PvString).
Optionally, repeat the two previous steps.
Save the stored information to disk. Use Save.

To load your state information:

See PvConfigurationReader.

Member Function Documentation

◆ Save()

PvResult PvConfigurationWriter::Save ( const PvString & aFilename )

Saves the configuration to a file.

Flush all stored configurations to disk.

Parameters

[in] aFilename Path to the output file.

Returns: Result of the operation.

The Save flushes writes all configurations in the PvConfigurationWriter object (using Store) to disk.

Parameters

[in] aFilename The configuration file's filename and path.

Returns

Includes:

PvResult::Code::OK
PvResult::Code::CANNOT_OPEN_FILE
PvResult::Code::GENERIC_ERROR (An error occured committing the content of the object to file.)

◆ SaveToString()

PvResult PvConfigurationWriter::SaveToString ( PvString & aString )

Saves the configuration to a string.

Parameters

[out] aString String to receive the configuration data.

Returns: Result of the operation.

The Save flushes writes all configurations in the PvConfigurationWriter object (using Store) to a string.

Parameters

[in] aString The string where the configurations are saved.

Returns

Includes:

◆ SetErrorList()

void PvConfigurationWriter::SetErrorList	(	PvStringList *	aList,
		const PvString &	aPrefix
	)

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

Sets the error list where all errors/warnings are logged.

Parameters

[in]	aList	String list to receive error messages.
[in]	aPrefix	Prefix to add to error messages.
[in]	aList	A pointer to a string list. The content of the list is not reset, new errors are simply added to the list.
[in]	aPrefix	A contextual prefix prepended to all errors as they are added to the error list.

◆ Store() [1/5]

PvResult PvConfigurationWriter::Store	(	const PvString &	aString,
		const PvString &	aName
	)

Stores a string value.

Store a custom string.

Parameters

[in]	aString	String value to store.
[in]	aName	Name/key for the stored string.

Returns: Result of the operation.

Can be used to persist application information other than PvDevice or PvStream status in a single configuration file.

To use this method, see Store(PvDevice *,PvString).

Parameters

[in]	aString	See Store(PvDevice ,PvString), aDevice* parameter.
[in]	aName	See Store(PvDevice *,PvString).

Returns: See Store(PvDevice *,PvString).

◆ Store() [2/5]

PvResult PvConfigurationWriter::Store	(	PvDevice *	aDevice,
		PvString	aName = `PvString( "" )`
	)

Stores configuration from a device.

Store a PvDevice configuration.

Parameters

[in]	aDevice	Device to store configuration from.
[in]	aName	Optional name for the stored configuration.

Returns: Result of the operation.

The Store family of methods add a configuration to the PvConfigurationWriter object. You must call Save to flush your configurations to disk.

The Store methods use a (ConfigurationType, ConfigurationName) parameter format. The ConfigurationType is the object (PvDevice, PvStream, or PvString); the ConfigurationName is an arbitrary identifying name for the configuration.

Parameters

[in]	aDevice	The configuration type; the object whose information will be stored. Other Store methods have similar behavior, but different data types (PvStream or PvString).
[in]	aName	The configuration name; an arbitrary identifying name for this configuration (since you set it, it may differ from the value returned by methods such as PvDeviceInfo::GetUserDefinedName).

Returns: See Store(PvDevice *,PvString).

◆ Store() [3/5]

PvResult PvConfigurationWriter::Store	(	PvGenParameterArray *	aGenParameterArray,
		PvString	aName = `PvString( "" )`,
		PvStringList *	aExtendedBlackList = `NULL`
	)

Stores configuration from a GenICam parameter array.

Store a PvGenParameterArray.

Parameters

[in]	aGenParameterArray	Parameter array to store configuration from.
[in]	aName	Optional name for the stored configuration.
[in]	aExtendedBlackList	Optional list of parameter names to exclude from storage.

Returns: Result of the operation.

Can be used to persist a PvGenParameterArray.

Parameters

[in]	aGenParameterArray	See Store(PvDevice ,PvString), aDevice* parameter.
[in]	aName	See Store(PvDevice *,PvString).
[in]	aExtendedBlackList	A list of parameter names to add to the parameter black list when saving.

Returns: See Store(PvDevice *,PvString).

◆ Store() [4/5]

PvResult PvConfigurationWriter::Store	(	PvPropertyList *	aPropertyList,
		PvString	aName = `PvString( "" )`
	)

Stores a property list.

Parameters

[in]	aPropertyList	Property list to store.
[in]	aName	Optional name for the stored configuration.

Returns: Result of the operation.

Can be used to persist a property list object. A property is name/value pair.

Parameters

[in]	aPropertyList	See Store(PvDevice ,PvString), aDevice* parameter.
[in]	aName	See Store(PvDevice *,PvString).

Returns: See Store(PvDevice *,PvString).

◆ Store() [5/5]

PvResult PvConfigurationWriter::Store	(	PvStream *	aStream,
		PvString	aName = `PvString( "" )`
	)

Stores configuration from a stream.

Store a PvStream configuration.

Parameters

[in]	aStream	Stream to store configuration from.
[in]	aName	Optional name for the stored configuration.

Returns: Result of the operation.

To use this method, see Store(PvDevice *,PvString).

Parameters

[in]	aStream	See Store(PvDevice ,PvString), aDevice* parameter.
[in]	aName	See Store(PvDevice *,PvString).

Returns

PvResult::Code::OK
PvResult::Code::INVALID_PARAMETER
PvResult::Code::GENERIC_ERROR (A problem occured adding the PvDevice, PvStream, or PvString configuration to the persistence object.)

The documentation for this class was generated from the following files:

PvConfigurationWriter.h
PvConfigurationWriter.cpp

eBUS SDK v7.0.1.7536 API

Public Member Functions

Detailed Description

Member Function Documentation

◆ Save()

◆ SaveToString()

◆ SetErrorList()

◆ Store() [1/5]

◆ Store() [2/5]

◆ Store() [3/5]

◆ Store() [4/5]

◆ Store() [5/5]