GENAPI_NAMESPACE::CFeatureBag Class Reference

Basic interface to persist values to. More...

#include <Persistence.h>

List of all members.

Public Member Functions
virtual void	Destroy ()
virtual const GENICAM_NAMESPACE::gcstring &	GetBagName (void) const
bool	LoadFromBag (INodeMap *pNodeMap, bool Verify=true, GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL)
	Loads the features from the bag to the node tree.
bool	operator== (const CFeatureBag &FeatureBag) const
	compares the content of two feature bags
virtual void	PersistFeature (IValue &item)
	Stores a feature.
virtual void	SetBagName (const GENICAM_NAMESPACE::gcstring &bagName)
virtual void	SetInfo (const GENICAM_NAMESPACE::gcstring &Info)
	sets information about the node map
int64_t	StoreToBag (INodeMap *pNodeMap, const int MaxNumPersistSkriptEntries=-1, GENICAM_NAMESPACE::gcstring_vector *pFeatureFilter=NULL)
	Stores the streamable nodes to this feature bag.
GENICAM_NAMESPACE::gcstring	ToString ()
Private Member Functions
bool	LoadFromBagInternal (INodeMap *pNodeMap, bool Verify, GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL)
int64_t	StoreToBagInternal (INodeMap *pNodeMap, const int MaxNumPersistSkriptEntries=-1, GENICAM_NAMESPACE::gcstring_vector *pFeatureFilter=NULL)
Private Attributes
GENICAM_NAMESPACE::gcstring	m_BagName
	The name of the feature bag.
GENICAM_NAMESPACE::gcstring	m_Info
	String describing the node map.
GENICAM_NAMESPACE::gcstring_vector	m_Names
GENICAM_NAMESPACE::gcstring_vector	m_Values
Friends
class	CFeatureBagger
std::ostream &	operator<< (std::ostream &os, const CFeatureBag &FeatureBag)
	puts the bag into a stream
std::istream &	operator>> (std::istream &is, CFeatureBag &FeatureBag)
	fills the bag from a stream

---

Detailed Description

Basic interface to persist values to.

Bag holding streamable features of a nodetree

Definition at line 53 of file Persistence.h.

---

Member Function Documentation

virtual void GENAPI_NAMESPACE::CFeatureBag::Destroy

(

)

[virtual]

virtual const GENICAM_NAMESPACE::gcstring& GENAPI_NAMESPACE::CFeatureBag::GetBagName

(

void

)

const [virtual]

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

Loads the features from the bag to the node tree.

Parameters:

pNodeMap	The node map to load into
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.

bool GENAPI_NAMESPACE::CFeatureBag::LoadFromBagInternal	(	INodeMap *	pNodeMap,
		bool	Verify,
		GENICAM_NAMESPACE::gcstring_vector *	pErrorList = NULL
	)		[private]

bool GENAPI_NAMESPACE::CFeatureBag::operator==

(

const CFeatureBag &

FeatureBag

)

const

compares the content of two feature bags

virtual void GENAPI_NAMESPACE::CFeatureBag::PersistFeature

(

IValue &

item

)

[virtual]

Stores a feature.

virtual void GENAPI_NAMESPACE::CFeatureBag::SetBagName

(

const GENICAM_NAMESPACE::gcstring &

bagName

)

[virtual]

virtual void GENAPI_NAMESPACE::CFeatureBag::SetInfo

(

const GENICAM_NAMESPACE::gcstring &

Info

)

[virtual]

sets information about the node map

int64_t GENAPI_NAMESPACE::CFeatureBag::StoreToBag	(	INodeMap *	pNodeMap,
		const int	MaxNumPersistSkriptEntries = -1,
		GENICAM_NAMESPACE::gcstring_vector *	pFeatureFilter = NULL
	)

Stores the streamable nodes to this feature bag.

Parameters:

pNodeMap	The node map to persist
MaxNumPersistSkriptEntries	The max number of entries in the container; -1 means unlimited
pFeatureFilter	List of valid feature; all feature if NULL.

Returns:

number of entries in the bag

int64_t GENAPI_NAMESPACE::CFeatureBag::StoreToBagInternal	(	INodeMap *	pNodeMap,
		const int	MaxNumPersistSkriptEntries = -1,
		GENICAM_NAMESPACE::gcstring_vector *	pFeatureFilter = NULL
	)		[private]

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFeatureBag::ToString

(

)

---

Friends And Related Function Documentation

friend class CFeatureBagger [friend]

Definition at line 108 of file Persistence.h.

std::ostream& operator<<	(	std::ostream &	os,
		const CFeatureBag &	FeatureBag
	)		[friend]

puts the bag into a stream

Definition at line 194 of file Persistence.h.

std::istream& operator>>	(	std::istream &	is,
		CFeatureBag &	FeatureBag
	)		[friend]

fills the bag from a stream

Definition at line 139 of file Persistence.h.

---

Member Data Documentation

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFeatureBag::m_BagName [private]

The name of the feature bag.

Definition at line 98 of file Persistence.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFeatureBag::m_Info [private]

String describing the node map.

Definition at line 103 of file Persistence.h.

GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::CFeatureBag::m_Names [private]

Definition at line 99 of file Persistence.h.

GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::CFeatureBag::m_Values [private]

Definition at line 100 of file Persistence.h.

---

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

• Persistence.h