All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Member Functions | List of all members
Pylon::CFeaturePersistence Class Reference

Utility class for saving and restoring camera features to and from a file or string. More...

#include <pylon/FeaturePersistence.h>

Static Public Member Functions

static void Load (const String_t &FileName, GenApi::INodeMap *pNodeMap, bool validate=true)
 Loads the features from the file to the node map. More...
 
static void Save (const String_t &FileName, GenApi::INodeMap *pNodeMap)
 Saves the node map to the file. More...
 
static void LoadFromString (const String_t &Features, GenApi::INodeMap *pNodeMap, bool validate=true)
 Loads the features from the string to the node map. More...
 
static void SaveToString (String_t &Features, GenApi::INodeMap *pNodeMap)
 Saves the node map to the string. More...
 

Detailed Description

Utility class for saving and restoring camera features to and from a file or string.

Note
When saving features, the behavior of cameras supporting sequencers depends on the current setting of the "SequenceEnable" (some GigE models) or "SequencerConfigurationMode" (USB only) features respectively.

Only if the sequencer is in configuration mode, are the sequence sets exported. Otherwise, the camera features are exported without sequence sets.

Member Function Documentation

static void Pylon::CFeaturePersistence::Load ( const String_t FileName,
GenApi::INodeMap *  pNodeMap,
bool  validate = true 
)
static

Loads the features from the file to the node map.

Parameters
[in]FileNameName of the file that contains the node map values.
[in]pNodeMapPointer to the node map
[in]validateIf validate==true, all node values will be validated. In case of an error, a GenICam::RuntimeException will be thrown
Error Safety: Throws an exception if loading fails.
static void Pylon::CFeaturePersistence::LoadFromString ( const String_t Features,
GenApi::INodeMap *  pNodeMap,
bool  validate = true 
)
static

Loads the features from the string to the node map.

Parameters
[in]FeaturesString containing the node map values.
[in]pNodeMapPointer to the node map.
[in]validateIf validate==true, all node values will be validated. In case of an error, a GenICam::RuntimeException will be thrown.
Error Safety: Throws an exception if loading fails.
static void Pylon::CFeaturePersistence::Save ( const String_t FileName,
GenApi::INodeMap *  pNodeMap 
)
static

Saves the node map to the file.

Sequence sets of a camera are automatically saved if SequenceEnable or SequencerConfigurationMode is enabled.

Parameters
[in]FileNameName of the file that contains the node map values
[in]pNodeMapPointer to the node map
Error Safety: Throws an exception if saving fails.
static void Pylon::CFeaturePersistence::SaveToString ( String_t Features,
GenApi::INodeMap *  pNodeMap 
)
static

Saves the node map to the string.

Sequence sets of a camera are automatically saved, if SequenceEnable or SequencerConfigurationMode is enabled.

Parameters
[out]FeaturesString containing the node map values
[in]pNodeMapPointer to the node map
Error Safety: Throws an exception if saving fails.

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

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)