SDK-eBUS/Ubuntu-LTS/eBUS_SDK_JAI_Ubuntu-24.04-x86_64-7.0.1-7536.zip

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

//

//     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

PvConfigurationWriter
Writes configuration data to persistence files.
Definition PvConfigurationWriter.h:29

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

PvConfigurationWriter::Save
PvResult Save(const PvString &aFilename)
Saves the configuration to a file.
Definition PvConfigurationWriter.cpp:222

PvConfigurationWriter::SetErrorList
void SetErrorList(PvStringList *aList, const PvString &aPrefix)
Sets the error list for collecting error messages during store operations.
Definition PvConfigurationWriter.cpp:261

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

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

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

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

PvGenParameterArray
GenICam feature array.
Definition PvGenParameterArray.h:73

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

PvResult
Result information.
Definition PvResult.h:30

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

PvString
String class.
Definition PvString.h:26

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