Skip to content

Pylon::CFeaturePersistence#

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

#include <pylon/FeaturePersistence.h>

Public Functions#

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

Detailed Description#

class Pylon::CFeaturePersistence;

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.

Public Functions Documentation#

Load#

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

Loads the features from the file to the node map.

Parameters:

  • FileName Name of the file that contains the node map values.
  • pNodeMap Pointer to the node map
  • validate If 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.

Save#

static void Save(
    const String_t & FileName,
    GenApi::INodeMap * pNodeMap
)

Saves the node map to the file.

Parameters:

  • FileName Name of the file that contains the node map values
  • pNodeMap Pointer to the node map

Error Safety: Throws an exception if saving fails.

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

LoadFromString#

static void LoadFromString(
    const String_t & Features,
    GenApi::INodeMap * pNodeMap,
    bool validate =true
)

Loads the features from the string to the node map.

Parameters:

  • Features String containing the node map values.
  • pNodeMap Pointer to the node map.
  • validate If 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.

SaveToString#

static void SaveToString(
    String_t & Features,
    GenApi::INodeMap * pNodeMap
)

Saves the node map to the string.

Parameters:

  • Features String containing the node map values
  • pNodeMap Pointer to the node map

Error Safety: Throws an exception if saving fails.

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


Updated on 27 July 2022 at 19:03:46