Class Spinnaker::GenApi::CFeatureBag¶

ClassList > GenApi > CFeatureBag

Bag holding streamable features of a nodetree.

#include <Persistence.h>

Inherits the following classes: IPersistScript

Public Functions¶

Type	Name
	CFeatureBag ()
void *	GetFeatureBagHandle ()
bool	LoadFromBag (INodeMap * pNodeMap, bool Verify=true, GenICam::gcstring_vector * pErrorList=NULL)
virtual void	PersistFeature (IValue & item)
virtual void	SetInfo (GenICam::gcstring & Info)
int64_t	StoreToBag (INodeMap * pNodeMap, const int MaxNumPersistSkriptEntries=-1) Stores the streamable nodes to this feature bag.
bool	operator== (const CFeatureBag & FeatureBag) const
virtual	~CFeatureBag ()

Public Functions Documentation¶

function CFeatureBag¶

GenApi::CFeatureBag::CFeatureBag ()

function GetFeatureBagHandle¶

void * GenApi::CFeatureBag::GetFeatureBagHandle ()

function LoadFromBag¶

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

Loads the features from the bag to the node tree

Parameters:

pNodeMap The node map
Verify If true, all streamable features are read back
pErrorList If 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.

function PersistFeature¶

virtual void GenApi::CFeatureBag::PersistFeature (
    IValue & item
)

Stores a feature

function SetInfo¶

virtual void GenApi::CFeatureBag::SetInfo (
    GenICam::gcstring & Info
)

sets information about the node map

function StoreToBag¶

Stores the streamable nodes to this feature bag.

int64_t GenApi::CFeatureBag::StoreToBag (
    INodeMap * pNodeMap,
    const  int MaxNumPersistSkriptEntries=-1
)

Parameters:

pNodeMap The node map to persist
MaxNumPersistSkriptEntries The max number of entries in the container; -1 means unlimited

Returns:

number of entries in the bag

function operator==¶

bool GenApi::CFeatureBag::operator== (
    const  CFeatureBag & FeatureBag
) const

compares the content of two feature bags

function ~CFeatureBag¶

virtual GenApi::CFeatureBag::~CFeatureBag ()

The documentation for this class was generated from the following file C:/workspace/include/SpinGenApi/Persistence.h