The main data access class for the data system. More...

#include <Accessor.h>

Inheritance diagram for fe::Accessor< T >:

[legend]

Public Member Functions
	Accessor (sp< Scope > scope, const String &attribute)

	Accessor (const Accessor< T > &other)

Accessor< T > &	operator= (const Accessor< T > &other)

T &	operator() (const RecordSB &r)
	Return the attribute. More...

const T	operator() (const RecordSB &r) const
	Return the attribute. More...

T &	operator() (const WeakRecordSB &r)
	Return the attribute. More...

const T	operator() (const WeakRecordSB &r) const
	Return the attribute. More...

T &	operator() (RecordSB *record)
	Return the attribute. More...

T &	operator() (sp< RecordArraySB > &rspRA, FE_UWORD index)
	Return the attribute. More...

const T &	operator() (sp< RecordArraySB > &rspRA, FE_UWORD index) const
	Return the attribute. More...

T &	operator() (hp< RecordArraySB > &rhpRA, FE_UWORD index)
	Return the attribute. More...

T &	operator() (const RecordSB &r, const char *message)
	Return the attribute. More...

bool	queryAttribute (const RecordSB &r, T *&data)
	Return true if the attribute exists in record. More...

bool	queryAttribute (const WeakRecordSB r, T *&data)
	Return true if the attribute exists in record. More...

T *	queryAttribute (const RecordSB &r)

T *	queryAttribute (const WeakRecordSB r)
	Return a pointer to the attribute if it exists in record. More...

T *	queryAttribute (RecordSB *pR)
	Return a pointer to the attribute if it exists in record. More...

T *	queryAttribute (sp< RecordArraySB > &rspRA, FE_UWORD index)
	Return a pointer to the attribute if it exists in record indexed into the RecordArraySB. More...

T &	operator() (const RecordAV &r)
	Return the attribute. More...

const T	operator() (const RecordAV &r) const
	Return the attribute. More...

T &	operator() (const WeakRecordAV &r)
	Return the attribute. More...

const T	operator() (const WeakRecordAV &r) const
	Return the attribute. More...

T &	operator() (RecordAV *record)
	Return the attribute. More...

T &	operator() (sp< RecordArrayAV > &rspRA, FE_UWORD index)
	Return the attribute. More...

const T &	operator() (sp< RecordArrayAV > &rspRA, FE_UWORD index) const
	Return the attribute. More...

T &	operator() (hp< RecordArrayAV > &rhpRA, FE_UWORD index)
	Return the attribute. More...

T &	operator() (const RecordAV &r, const char *message)
	Return the attribute. More...

bool	queryAttribute (const RecordAV &r, T *&data)
	Return true if the attribute exists in record. More...

bool	queryAttribute (const WeakRecordAV r, T *&data)
	Return true if the attribute exists in record. More...

T *	queryAttribute (const RecordAV &r)

T *	queryAttribute (const WeakRecordAV r)
	Return a pointer to the attribute if it exists in record. More...

T *	queryAttribute (RecordAV *pR)
	Return a pointer to the attribute if it exists in record. More...

T *	queryAttribute (sp< RecordArrayAV > &rspRA, FE_UWORD index)
	Return a pointer to the attribute if it exists in record indexed into the RecordArrayAV. More...

bool	operator() (const RecordAV &record, T &data)

bool	operator() (const WeakRecordAV &record, T &data)

bool	operator() (const RecordSB &record, T &data)

bool	operator() (const WeakRecordSB &record, T &data)

void	registerDefault (T *pT)

T *	operator() (const sp< LayoutAV > &spLayout)

Accessor< T > &	operator= (const T &a_value)

T *	operator* (void)

	operator T & ()

T &	c_val (void)

Public Member Functions inherited from fe::BaseAccessor
void	initialize (sp< Scope > scope, const String &attribute)
	initialize functions setup the accessor but do not setup anything with the Scope. More...

void	initialize (Scope *pScope, const String &attribute)
	initialize functions setup the accessor but do not setup anything with the Scope. More...

void	initialize (sp< Scope > scope, sp< Attribute > spAttribute)
	initialize functions setup the accessor but do not setup anything with the Scope. More...

void	setup (sp< Scope > spScope, const String &attribute)
	setup functions setup the accessor and also setup the Scope. More...

void	setup (sp< Scope > scope, const String &attribute, const String &attributetype)
	setup functions setup the accessor and also setup the Scope. More...

void	populate (sp< Scope > spScope, const String &layout, const String &attribute)
	setup the accessor and populate the named Layout, creating the Layout if neccessary More...

sp< Scope >	scope (void) const

bool	operator== (const BaseAccessor &other) const

bool	operator< (const BaseAccessor &other) const

BaseAccessor &	operator= (const BaseAccessor &other)

	operator FE_UWORD () const

FE_UWORD	index (void) const

bool	check (const RecordSB &r) const
	Return true if record has attribute. More...

bool	check (const WeakRecordSB &r) const
	Return true if record has attribute. More...

bool	check (RecordSB *pR) const
	Return true if record has attribute. More...

bool	check (sp< RecordArraySB > &rspRA) const
	Return true if spRA has attribute. More...

bool	check (RecordArraySB &rRA) const
	Return true if rRA has attribute. More...

bool	check (sp< LayoutSB > &rspL) const
	Return true if spL has attribute. More...

bool	check (LayoutSB &rL) const
	Return true if L has attribute. More...

bool	check (const RecordAV &r) const
	Return true if record has attribute. More...

bool	check (const WeakRecordAV &r) const
	Return true if record has attribute. More...

bool	check (RecordAV *pR) const
	Return true if record has attribute. More...

bool	check (sp< RecordArrayAV > &rspRA) const
	Return true if spRA has attribute. More...

bool	check (RecordArrayAV &rRA) const
	Return true if rRA has attribute. More...

bool	check (sp< LayoutAV > &rspL) const
	Return true if spL has attribute. More...

bool	check (LayoutAV &rL) const
	Return true if L has attribute. More...

bool	check (sp< Layout > &rspL) const

bool	check (Layout &rL) const

sp< Attribute >	attribute (void) const
	Return the attribute this accessor is for. More...

const String &	name (void) const

void	bind (const WeakRecord &a_record)
	optionally bind to a record More...

void	typeCheck (const String &attribute)

Private Attributes
T *	m_pT

Additional Inherited Members
Protected Attributes inherited from fe::BaseAccessor
FE_UWORD	m_index

hp< Scope >	m_hpScope

TypeInfo	m_typeInfo

WeakRecord	m_optional_record

Detailed Description

template<class T>
class fe::Accessor< T >

The main data access class for the data system.

Member Function Documentation

◆ operator()() [1/18]

template<class T >

T & fe::Accessor< T >::operator() ( const RecordSB & r )

inline

Return the attribute.

Checking for existence is not done

Referenced by fe::Accessor< fe::sp< fe::RecordGroup > >::queryAttribute().

◆ operator()() [2/18]

template<class T >

const T fe::Accessor< T >::operator() ( const RecordSB & r ) const

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [3/18]

template<class T >

T & fe::Accessor< T >::operator() ( const WeakRecordSB & r )

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [4/18]

template<class T >

const T fe::Accessor< T >::operator() ( const WeakRecordSB & r ) const

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [5/18]

template<class T >

T & fe::Accessor< T >::operator() ( RecordSB * record )

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [6/18]

template<class T >

T & fe::Accessor< T >::operator()	(	sp< RecordArraySB > &	rspRA,
		FE_UWORD	index
	)

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [7/18]

template<class T >

const T & fe::Accessor< T >::operator()	(	sp< RecordArraySB > &	rspRA,
		FE_UWORD	index
	)		const

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [8/18]

template<class T >

T & fe::Accessor< T >::operator()	(	hp< RecordArraySB > &	rhpRA,
		FE_UWORD	index
	)

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [9/18]

template<class T >

T & fe::Accessor< T >::operator()	(	const RecordSB &	r,
		const char *	message
	)

inline

Return the attribute.

Checking for existence is done. If the attribute does not exist then an Exception is thrown

◆ operator()() [10/18]

template<class T >

T & fe::Accessor< T >::operator() ( const RecordAV & r )

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [11/18]

template<class T >

const T fe::Accessor< T >::operator() ( const RecordAV & r ) const

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [12/18]

template<class T >

T & fe::Accessor< T >::operator() ( const WeakRecordAV & r )

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [13/18]

template<class T >

const T fe::Accessor< T >::operator() ( const WeakRecordAV & r ) const

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [14/18]

template<class T >

T & fe::Accessor< T >::operator() ( RecordAV * record )

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [15/18]

template<class T >

T & fe::Accessor< T >::operator()	(	sp< RecordArrayAV > &	rspRA,
		FE_UWORD	index
	)

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [16/18]

template<class T >

const T & fe::Accessor< T >::operator()	(	sp< RecordArrayAV > &	rspRA,
		FE_UWORD	index
	)		const

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [17/18]

template<class T >

T & fe::Accessor< T >::operator()	(	hp< RecordArrayAV > &	rhpRA,
		FE_UWORD	index
	)

inline

Return the attribute.

Checking for existence is not done

◆ operator()() [18/18]

template<class T >

T & fe::Accessor< T >::operator()	(	const RecordAV &	r,
		const char *	message
	)

inline

Return the attribute.

Checking for existence is done. If the attribute does not exist then an Exception is thrown

◆ queryAttribute() [1/10]

template<class T>

bool fe::Accessor< T >::queryAttribute	(	const RecordSB &	r,
		T *&	data
	)

inline

Return true if the attribute exists in record.

Return the attribute data in

Referenced by fe::ext::Relay< SIZE, TYPE, BASE >::print(), and fe::Accessor< fe::sp< fe::RecordGroup > >::queryAttribute().

◆ queryAttribute() [2/10]

template<class T>

bool fe::Accessor< T >::queryAttribute	(	const WeakRecordSB	r,
		T *&	data
	)

inline

Return true if the attribute exists in record.

Return the attribute data in

◆ queryAttribute() [3/10]

template<class T>

T * fe::Accessor< T >::queryAttribute ( const WeakRecordSB r )

inline

Return a pointer to the attribute if it exists in record.

Otherwise return NULL

◆ queryAttribute() [4/10]

template<class T>

T * fe::Accessor< T >::queryAttribute ( RecordSB * pR )

inline

Return a pointer to the attribute if it exists in record.

Otherwise return NULL

◆ queryAttribute() [5/10]

template<class T>

T * fe::Accessor< T >::queryAttribute	(	sp< RecordArraySB > &	rspRA,
		FE_UWORD	index
	)

inline

Return a pointer to the attribute if it exists in record indexed into the RecordArraySB.

Otherwise return NULL

◆ queryAttribute() [6/10]

template<class T>

bool fe::Accessor< T >::queryAttribute	(	const RecordAV &	r,
		T *&	data
	)

inline

Return true if the attribute exists in record.

Return the attribute data in

◆ queryAttribute() [7/10]

template<class T>

bool fe::Accessor< T >::queryAttribute	(	const WeakRecordAV	r,
		T *&	data
	)

inline

Return true if the attribute exists in record.

Return the attribute data in

◆ queryAttribute() [8/10]

template<class T>

T * fe::Accessor< T >::queryAttribute ( const WeakRecordAV r )

inline

Return a pointer to the attribute if it exists in record.

Otherwise return NULL

◆ queryAttribute() [9/10]

template<class T>

T * fe::Accessor< T >::queryAttribute ( RecordAV * pR )

inline

Return a pointer to the attribute if it exists in record.

Otherwise return NULL

◆ queryAttribute() [10/10]

template<class T>

T * fe::Accessor< T >::queryAttribute	(	sp< RecordArrayAV > &	rspRA,
		FE_UWORD	index
	)

inline

Return a pointer to the attribute if it exists in record indexed into the RecordArrayAV.

Otherwise return NULL

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

Accessor.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class fe::Accessor< T >

Member Function Documentation

◆ operator()() [1/18]

◆ operator()() [2/18]

◆ operator()() [3/18]

◆ operator()() [4/18]

◆ operator()() [5/18]

◆ operator()() [6/18]

◆ operator()() [7/18]

◆ operator()() [8/18]

◆ operator()() [9/18]

◆ operator()() [10/18]

◆ operator()() [11/18]

◆ operator()() [12/18]

◆ operator()() [13/18]

◆ operator()() [14/18]

◆ operator()() [15/18]

◆ operator()() [16/18]

◆ operator()() [17/18]

◆ operator()() [18/18]

◆ queryAttribute() [1/10]

◆ queryAttribute() [2/10]

◆ queryAttribute() [3/10]

◆ queryAttribute() [4/10]

◆ queryAttribute() [5/10]

◆ queryAttribute() [6/10]

◆ queryAttribute() [7/10]

◆ queryAttribute() [8/10]

◆ queryAttribute() [9/10]

◆ queryAttribute() [10/10]

template<class T>
class fe::Accessor< T >