Class use to bag features. More...

#include <Persistence.h>

Classes
class	const_iterator

Public Member Functions
virtual const CFeatureBag &	at (size_t uiIndex) const

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...

virtual const_iterator	begin (void) const

	CFeatureBagger ()

virtual const_iterator	end (void) const

virtual void	SetInfo (const GENICAM_NAMESPACE::gcstring &Info)
	sets information about the node map More...

virtual size_t	size (void) const

bool	UnBag (INodeMap pNodeMap, bool Verify=true, GENICAM_NAMESPACE::gcstring_vector pErrorList=NULL)
	Loads the features from the bag to the node tree. More...

virtual	~CFeatureBagger ()

Private Member Functions
CFeatureBag &	AddBag (const GENICAM_NAMESPACE::gcstring &bagName)

void	DeleteAllBags (void)

template<class _Ty >
void	UnBagCustomAction (INodeMap *pNodeMap, _Ty setNodePtr, const GENICAM_NAMESPACE::gcstring &setNodeValue, CCommandPtr saveNodePtr)

Private Attributes
GENICAM_NAMESPACE::gcstring	m_Info
	String describing the node map. More...

void *	m_pBags

Friends
std::ostream &	operator<< (std::ostream &os, const CFeatureBagger &featureBagger)
	puts the bags into a stream More...

std::istream &	operator>> (std::istream &is, CFeatureBagger &featureBagger)
	reads the bags from a stream More...

Detailed Description

Class use to bag features.

Definition at line 221 of file Persistence.h.

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CFeatureBagger::CFeatureBagger ( )

explicit

virtual GENAPI_NAMESPACE::CFeatureBagger::~CFeatureBagger ( )

virtual

Member Function Documentation

CFeatureBag& GENAPI_NAMESPACE::CFeatureBagger::AddBag ( const GENICAM_NAMESPACE::gcstring & bagName )

private

virtual const CFeatureBag& GENAPI_NAMESPACE::CFeatureBagger::at ( size_t uiIndex ) const

virtual

size_t GENAPI_NAMESPACE::CFeatureBagger::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.

Parameters

handleDefaultNodeMap	Stores the current nodemap if True
handleUserSets	Store all user sets if True
handleSequencerSets	Store all sequencer sets if True
pNodeMap	The node map to persist
MaxNumPersistSkriptEntries	The max number of entries in the container. -1 means unlimited

Returns: number of bags

virtual const_iterator GENAPI_NAMESPACE::CFeatureBagger::begin ( void ) const

virtual

void GENAPI_NAMESPACE::CFeatureBagger::DeleteAllBags ( void )

private

virtual const_iterator GENAPI_NAMESPACE::CFeatureBagger::end ( void ) const

virtual

virtual void GENAPI_NAMESPACE::CFeatureBagger::SetInfo ( const GENICAM_NAMESPACE::gcstring & Info )

virtual

sets information about the node map

virtual size_t GENAPI_NAMESPACE::CFeatureBagger::size ( void ) const

virtual

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

Loads the features from the bag to the node tree.

Parameters

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.

template<class _Ty >

void GENAPI_NAMESPACE::CFeatureBagger::UnBagCustomAction	(	INodeMap *	pNodeMap,
		_Ty	setNodePtr,
		const GENICAM_NAMESPACE::gcstring &	setNodeValue,
		CCommandPtr	saveNodePtr
	)

private

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CFeatureBagger &	featureBagger
	)

friend

puts the bags into a stream

Definition at line 301 of file Persistence.h.

std::istream& operator>>	(	std::istream &	is,
		CFeatureBagger &	featureBagger
	)

friend

reads the bags from a stream

Definition at line 323 of file Persistence.h.

Member Data Documentation

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFeatureBagger::m_Info

private

String describing the node map.

Definition at line 294 of file Persistence.h.

void* GENAPI_NAMESPACE::CFeatureBagger::m_pBags

private

Definition at line 292 of file Persistence.h.

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

Persistence.h

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation