GENAPI_NAMESPACE::CFeatureBag Class Reference

Basic interface to persist values to. More...

#include <Persistence.h>

List of all members.

Public Member Functions
bool	LoadFromBag (INodeMap *pNodeMap, bool Verify=true, gcstring_vector *pErrorList=NULL)
bool	operator== (const CFeatureBag &FeatureBag) const
	compares the content of two feature bags
virtual void	PersistFeature (IValue &item)
	Stores a feature.
virtual void	SetInfo (gcstring &Info)
	sets information about the node map
int64_t	StoreToBag (INodeMap *pNodeMap, const int MaxNumPersistSkriptEntries=-1)
	Stores the streamable nodes to this feature bag.
gcstring	ToString ()
Private Attributes
gcstring	m_Info
	String describing the node map.
gcstring_vector	m_Names
	The features are stored in a list of string pairs = {Name, Value}.
gcstring_vector	m_Values
	The features are stored in a list of string pairs = {Name, Value}.
Friends
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 55 of file Persistence.h.

---

Member Function Documentation

bool GENAPI_NAMESPACE::CFeatureBag::LoadFromBag	(	INodeMap *	pNodeMap,
		bool	Verify = true,
		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.

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::SetInfo

(

gcstring &

Info

)

[virtual]

sets information about the node map

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

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

Returns:

number of entries in the bag

gcstring GENAPI_NAMESPACE::CFeatureBag::ToString

(

)

---

Friends And Related Function Documentation

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

puts the bag into a stream

Definition at line 171 of file Persistence.h.

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

fills the bag from a stream

Definition at line 127 of file Persistence.h.

---

Member Data Documentation

gcstring GENAPI_NAMESPACE::CFeatureBag::m_Info [private]

String describing the node map.

Definition at line 100 of file Persistence.h.

gcstring_vector GENAPI_NAMESPACE::CFeatureBag::m_Names [private]

The features are stored in a list of string pairs = {Name, Value}.

Definition at line 94 of file Persistence.h.

gcstring_vector GENAPI_NAMESPACE::CFeatureBag::m_Values [private]

The features are stored in a list of string pairs = {Name, Value}.

Definition at line 97 of file Persistence.h.

---

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

• Persistence.h