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

#include <Persistence.h>

Inheritance diagram for GENAPI_NAMESPACE::CFeatureBag:

Classes
class	const_iterator

struct	Triplet

Public Member Functions
	CFeatureBag ()

	CFeatureBag (const CFeatureBag &)

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

CFeatureBag &	operator= (const CFeatureBag &)

bool	operator== (const CFeatureBag &FeatureBag) const
	compares the content of two feature bags More...

virtual void	PersistFeature (IValue &item, CSelectorSet *selectorSet=NULL)
	Stores a feature. More...

virtual void	SetBagName (const GENICAM_NAMESPACE::gcstring &bagName)

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

int64_t	StoreToBag (INodeMap pNodeMap, const int MaxNumPersistSkriptEntries=-1, GENICAM_NAMESPACE::gcstring_vector pFeatureFilter=NULL)
	Stores the streamable nodes to this feature bag. More...

GENICAM_NAMESPACE::gcstring	ToString ()

virtual	~CFeatureBag ()

Private Member Functions
CSelectorState *	AllocateSelector ()

void	Clear ()

void	DeleteSelector (CSelectorState *&p)

const_iterator	GetBegin ()

const_iterator	GetBegin () const

const_iterator	GetEnd ()

const_iterator	GetEnd () const

const GENICAM_NAMESPACE::gcstring &	GetInfo () const

bool	LoadFromBagInternal (INodeMap pNodeMap, bool Verify, GENICAM_NAMESPACE::gcstring_vector pErrorList=NULL)

void	Push (const char name, const char value, CSelectorState *ps)

int64_t	StoreToBagInternal (INodeMap pNodeMap, const int MaxNumPersistSkriptEntries=-1, GENICAM_NAMESPACE::gcstring_vector pFeatureFilter=NULL)

Private Attributes
FeatureBagImpl *	m_pImpl

Friends
class	CFeatureBagger

std::ostream &	operator<< (std::ostream &os, const CFeatureBag &FeatureBag)
	puts the bag into a stream More...

std::istream &	operator>> (std::istream &is, CFeatureBag &FeatureBag)
	fills the bag from a stream More...

Detailed Description

Bag holding streamable features of a nodetree.

Definition at line 56 of file Persistence.h.

Constructor & Destructor Documentation

◆ CFeatureBag() [1/2]

GENAPI_NAMESPACE::CFeatureBag::CFeatureBag ( )

◆ CFeatureBag() [2/2]

GENAPI_NAMESPACE::CFeatureBag::CFeatureBag ( const CFeatureBag & )

◆ ~CFeatureBag()

virtual GENAPI_NAMESPACE::CFeatureBag::~CFeatureBag ( )

virtual

Member Function Documentation

◆ AllocateSelector()

CSelectorState* GENAPI_NAMESPACE::CFeatureBag::AllocateSelector ( )

private

◆ Clear()

void GENAPI_NAMESPACE::CFeatureBag::Clear ( )

private

◆ DeleteSelector()

void GENAPI_NAMESPACE::CFeatureBag::DeleteSelector ( CSelectorState *& p )

private

◆ Destroy()

virtual void GENAPI_NAMESPACE::CFeatureBag::Destroy ( )

virtual

◆ GetBagName()

virtual const GENICAM_NAMESPACE::gcstring& GENAPI_NAMESPACE::CFeatureBag::GetBagName ( void ) const

virtual

◆ GetBegin() [1/2]

const_iterator GENAPI_NAMESPACE::CFeatureBag::GetBegin ( )

private

◆ GetBegin() [2/2]

const_iterator GENAPI_NAMESPACE::CFeatureBag::GetBegin ( ) const

private

◆ GetEnd() [1/2]

const_iterator GENAPI_NAMESPACE::CFeatureBag::GetEnd ( )

private

◆ GetEnd() [2/2]

const_iterator GENAPI_NAMESPACE::CFeatureBag::GetEnd ( ) const

private

◆ GetInfo()

const GENICAM_NAMESPACE::gcstring& GENAPI_NAMESPACE::CFeatureBag::GetInfo ( ) const

private

◆ LoadFromBag()

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.

◆ LoadFromBagInternal()

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

private

◆ operator=()

CFeatureBag& GENAPI_NAMESPACE::CFeatureBag::operator= ( const CFeatureBag & )

◆ operator==()

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

compares the content of two feature bags

◆ PersistFeature()

virtual void GENAPI_NAMESPACE::CFeatureBag::PersistFeature	(	IValue &	item,
		CSelectorSet *	selectorSet = `NULL`
	)

virtual

Stores a feature.

◆ Push()

void GENAPI_NAMESPACE::CFeatureBag::Push	(	const char *	name,
		const char *	value,
		CSelectorState *	ps
	)

private

◆ SetBagName()

virtual void GENAPI_NAMESPACE::CFeatureBag::SetBagName ( const GENICAM_NAMESPACE::gcstring & bagName )

virtual

◆ SetInfo()

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

virtual

sets information about the node map

◆ StoreToBag()

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

◆ StoreToBagInternal()

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

private

◆ ToString()

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFeatureBag::ToString ( )

Friends And Related Function Documentation

◆ CFeatureBagger

friend class CFeatureBagger

friend

Definition at line 160 of file Persistence.h.

◆ operator<<

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

friend

puts the bag into a stream

Definition at line 315 of file Persistence.h.

◆ operator>>

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

friend

fills the bag from a stream

Definition at line 220 of file Persistence.h.

Member Data Documentation

◆ m_pImpl

FeatureBagImpl* GENAPI_NAMESPACE::CFeatureBag::m_pImpl

private

Definition at line 153 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

◆ CFeatureBag() [1/2]

◆ CFeatureBag() [2/2]

◆ ~CFeatureBag()

Member Function Documentation

◆ AllocateSelector()

◆ Clear()

◆ DeleteSelector()

◆ Destroy()

◆ GetBagName()

◆ GetBegin() [1/2]

◆ GetBegin() [2/2]

◆ GetEnd() [1/2]

◆ GetEnd() [2/2]

◆ GetInfo()

◆ LoadFromBag()

◆ LoadFromBagInternal()

◆ operator=()

◆ operator==()

◆ PersistFeature()

◆ Push()

◆ SetBagName()

◆ SetInfo()

◆ StoreToBag()

◆ StoreToBagInternal()

◆ ToString()

Friends And Related Function Documentation

◆ CFeatureBagger

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_pImpl