Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
CFeatureBag Class Reference

Bag holding streamable features of a nodetree. More...

Inheritance diagram for CFeatureBag:

Public Member Functions

 CFeatureBag ()
 
virtual ~CFeatureBag ()
 
virtual void SetInfo (GenICam::gcstring &Info)
 sets information about the node map More...
 
virtual void PersistFeature (IValue &item)
 Stores a feature. More...
 
bool LoadFromBag (INodeMap *pNodeMap, bool Verify=true, GenICam::gcstring_vector *pErrorList=NULL)
 Loads the features from the bag to the node tree. More...
 
int64_t StoreToBag (INodeMap *pNodeMap, const int MaxNumPersistSkriptEntries=-1)
 Stores the streamable nodes to this feature bag. More...
 
bool operator== (const CFeatureBag &FeatureBag) const
 compares the content of two feature bags More...
 
void * GetFeatureBagHandle ()
 

Detailed Description

Bag holding streamable features of a nodetree.

Constructor & Destructor Documentation

virtual ~CFeatureBag ( )
virtual

Member Function Documentation

void* GetFeatureBagHandle ( )
bool LoadFromBag ( INodeMap pNodeMap,
bool  Verify = true,
GenICam::gcstring_vector *  pErrorList = NULL 
)

Loads the features from the bag to the node tree.

Parameters
pNodeMapThe node map
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.

bool operator== ( const CFeatureBag FeatureBag) const

compares the content of two feature bags

virtual void PersistFeature ( IValue item)
virtual

Stores a feature.

virtual void SetInfo ( GenICam::gcstring Info)
virtual

sets information about the node map

int64_t StoreToBag ( INodeMap pNodeMap,
const int  MaxNumPersistSkriptEntries = -1 
)

Stores the streamable nodes to this feature bag.

Parameters
pNodeMapThe node map to persist
MaxNumPersistSkriptEntriesThe max number of entries in the container; -1 means unlimited
Returns
number of entries in the bag

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference