GenApi  3.5.1
Public Member Functions | Friends | List of all members
CFeatureBagger Class Reference

Class use to bag features.

Public Member Functions

size_t Bag (INodeMap *pNodeMap, bool handleDefaultNodeMap=true, bool handleUserSets=false, bool handleSequencerSets=false, const int MaxNumPersistSkriptEntries=-1)
 Stores the streamable nodes to this feature bags in different device configurations. More...
 
bool UnBag (INodeMap *pNodeMap, bool Verify=true, GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL)
 
virtual void SetInfo (const GENICAM_NAMESPACE::gcstring &Info)
 sets information about the node map
 

Friends

std::ostream & operator<< (std::ostream &os, const CFeatureBagger &featureBagger)
 puts the bags into a stream
 
std::istream & operator>> (std::istream &is, CFeatureBagger &featureBagger)
 reads the bags from a stream
 

Member Function Documentation

◆ Bag()

size_t Bag ( INodeMap *  pNodeMap,
bool  handleDefaultNodeMap = true,
bool  handleUserSets = false,
bool  handleSequencerSets = false,
const int  MaxNumPersistSkriptEntries = -1 
)
Parameters
handleDefaultNodeMapStores the current nodemap if True
handleUserSetsStore all user sets if True
handleSequencerSetsStore all sequencer sets if True
pNodeMapThe node map to persist
MaxNumPersistSkriptEntriesThe max number of entries in the container. -1 means unlimited
Returns
number of bags

◆ UnBag()

bool UnBag ( INodeMap *  pNodeMap,
bool  Verify = true,
GENICAM_NAMESPACE::gcstring_vector *  pErrorList = NULL 
)

Loads the features from the bag to the node tree

Parameters
VerifyIf true, all streamable features are read back
pErrorListIf an error occurs during loading the error message is stored in the list and the loading continues

For Verify=true the list of names in the feature bag is replayed again. If a node is a selector it's value is set to the value from the feature bag If not the value is read from the camera and compared with the value from the feature bag.