doc/sdk/_pv_configuration_writer_8h_source.html

 // *****************************************************************************

 //

 //     Copyright (c) 2008, Pleora Technologies Inc., All rights reserved.

 //

 // *****************************************************************************


 #ifndef __PVCONFIGURATIONWRITER_H__

 #define __PVCONFIGURATIONWRITER_H__


 #include <PvPersistenceLib.h>

 #include <PvDevice.h>

 #include <PvStream.h>

 #include <PvStringList.h>

 #include <PvPropertyList.h>


 namespace PvPersistenceLib

 {

     class ConfigurationWriter;

 }


 class PvConfigurationWriter

 {

 public:


     PV_PERSISTENCE_API PvConfigurationWriter();

     PV_PERSISTENCE_API ~PvConfigurationWriter();


     PV_PERSISTENCE_API PvResult Store( PvDevice *aDevice, PvString aName = PvString( "" ) );

     PV_PERSISTENCE_API PvResult Store( PvStream *aStream, PvString aName = PvString( "" ) );

     PV_PERSISTENCE_API PvResult Store( const PvString &aString, const PvString &aName );

     PV_PERSISTENCE_API PvResult Store( PvGenParameterArray *aGenParameterArray, PvString aName = PvString( "" ), PvStringList *aExtendedBlackList = NULL );

     PV_PERSISTENCE_API PvResult Store( PvPropertyList *aPropertyList, PvString aName = PvString( "" ) );


     PV_PERSISTENCE_API PvResult Save( const PvString &aFilename );

     PV_PERSISTENCE_API PvResult SaveToString( PvString &aString );


     PV_PERSISTENCE_API void SetErrorList( PvStringList *aList, const PvString &aPrefix );


 protected:


 private:


     PvPersistenceLib::ConfigurationWriter *mThis;


     PvStringList *mErrorList;

     PvString mErrorPrefix;


     // Not implemented

     PvConfigurationWriter( const PvConfigurationWriter& );

     const PvConfigurationWriter &operator=( const PvConfigurationWriter & );


 };


 #endif

PvStream
Receive data from a GigE Vision or USB3 Vision transmitter.
Definition: PvStream.h:39

PvConfigurationWriter::~PvConfigurationWriter
~PvConfigurationWriter()
Destructor.
Definition: PvConfigurationWriter.cpp:62

PvString
String class.
Definition: PvString.h:21

PvConfigurationWriter::Store
PvResult Store(PvDevice *aDevice, PvString aName=PvString(""))
Store a PvDevice configuration.
Definition: PvConfigurationWriter.cpp:92

PvResult
Result information.
Definition: PvResult.h:13

PvConfigurationWriter
Save the state of the system.
Definition: PvConfigurationWriter.h:23

PvConfigurationWriter::PvConfigurationWriter
PvConfigurationWriter()
Constructor.
Definition: PvConfigurationWriter.cpp:49

PvStringList
Class used to hold a group of PvString objects.
Definition: PvStringList.h:19

PvConfigurationWriter::Save
PvResult Save(const PvString &aFilename)
Flush all stored configurations to disk.
Definition: PvConfigurationWriter.cpp:222

PvConfigurationWriter::SaveToString
PvResult SaveToString(PvString &aString)
Saves the configuration to a string.
Definition: PvConfigurationWriter.cpp:242

PvPropertyList
Class used to hold a group of PvProperty objects.
Definition: PvPropertyList.h:20

PvGenParameterArray
GenICam feature array.
Definition: PvGenParameterArray.h:38

PvDevice
Connect, configure and control a GigE Vision or USB3 Vision device.
Definition: PvDevice.h:30

PvConfigurationWriter::SetErrorList
void SetErrorList(PvStringList *aList, const PvString &aPrefix)
Sets the error list where all errors/warnings are logged.
Definition: PvConfigurationWriter.cpp:261