Detailed Description

template<class t_Pointer>
class ariles::NonNullPointer< t_Pointer >

Definition at line 236 of file types.h.

#include <types.h>

Inheritance diagram for ariles::NonNullPointer< t_Pointer >:

Public Types
typedef t_Pointer	BasePointer

typedef PointerHandler< t_Pointer >	Handler

Public Member Functions
	NonNullPointer ()

	NonNullPointer (const t_Pointer &value)

	operator BasePointer & ()

	operator const BasePointer & () const

	NonNullPointer (const typename Handler::Value &value)

virtual	~NonNullPointer ()

Handler::Value *	operator-> () const

Handler::Value &	operator * () const

void	writeConfigEntries (ariles::WriterBase &writer, const ariles::ConfigurableFlags &parameters) const

void	readConfigEntries (ariles::ReaderBase &reader, const ariles::ConfigurableFlags &parameters)

void	arilesFinalize ()

void	setDefaults ()

std::size_t	getNumberOfEntries () const
	Get number of entries in the corresponding configuration node. More...

bool	isNull () const

template<class t_Other >
bool	arilesCompare (const t_Other &other, const ariles::ComparisonParameters &param) const

virtual const ConfigurableFlags &	getArilesConfigurableFlags () const

virtual void	finalize ()

virtual const std::string &	getConfigSectionID () const =0
	Return the default name of a configuration node corresponding to this class. More...

void	readConfig (ariles::ReaderBase &reader, const ariles::ConfigurableFlags &param)
	Read configuration (assuming the configuration node to be in the root). More...

void	readConfig (ariles::ReaderBase &reader)

virtual void	readConfig (ariles::ReaderBase &reader, const std::string &node_name, const ariles::ReaderBase::Parameters &param)=0

void	readConfig (ariles::ReaderBase &reader, const std::string &node_name)

virtual void	readConfig (ariles::ReaderBase &reader, const char *node_name, const ariles::ReaderBase::Parameters &param)=0

void	readConfig (ariles::ReaderBase &reader, const char *node_name)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (t_ReaderInitializer &reader_initializer)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (t_ReaderInitializer &reader_initializer, const ariles::ConfigurableFlags &param)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (const t_ReaderInitializer &reader_initializer)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (const t_ReaderInitializer &reader_initializer, const ariles::ConfigurableFlags &param)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (t_ReaderInitializer &reader_initializer, const std::string &node_name)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (t_ReaderInitializer &reader_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (const t_ReaderInitializer &reader_initializer, const std::string &node_name)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (const t_ReaderInitializer &reader_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (t_ReaderInitializer &reader_initializer, const char *node_name)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (t_ReaderInitializer &reader_initializer, const char *node_name, const ariles::ConfigurableFlags &param)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (const t_ReaderInitializer &reader_initializer, const char *node_name)

template<class t_Bridge , class t_ReaderInitializer >
void	readConfig (const t_ReaderInitializer &reader_initializer, const char *node_name, const ariles::ConfigurableFlags &param)

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (t_WriterInitializer &writer_initializer) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (t_WriterInitializer &writer_initializer, const ariles::ConfigurableFlags &param) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (const t_WriterInitializer &writer_initializer) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (const t_WriterInitializer &writer_initializer, const ariles::ConfigurableFlags &param) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (t_WriterInitializer &writer_initializer, const std::string &node_name) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (t_WriterInitializer &writer_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (const t_WriterInitializer &writer_initializer, const std::string &node_name) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (const t_WriterInitializer &writer_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (t_WriterInitializer &writer_initializer, const char *node_name) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (t_WriterInitializer &writer_initializer, const char *node_name, const ariles::ConfigurableFlags &param) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (const t_WriterInitializer &writer_initializer, const char *node_name) const

template<class t_Bridge , class t_WriterInitializer >
void	writeConfig (const t_WriterInitializer &writer_initializer, const char *node_name, const ariles::ConfigurableFlags &param) const

void	writeConfig (ariles::WriterBase &writer, const ariles::ConfigurableFlags &param) const
	Write configuration. More...

void	writeConfig (ariles::WriterBase &writer) const

virtual void	writeConfig (ariles::WriterBase &writer, const std::string &node_name, const ariles::ConfigurableFlags &param) const =0

void	writeConfig (ariles::WriterBase &writer, const std::string &node_name) const

virtual void	writeConfig (ariles::WriterBase &writer, const char *node_name, const ariles::ConfigurableFlags &param) const =0

void	writeConfig (ariles::WriterBase &writer, const char *node_name) const

Public Attributes
t_Pointer	value_

Member Typedef Documentation

◆ BasePointer

template<class t_Pointer >

typedef t_Pointer ariles::NonNullPointer< t_Pointer >::BasePointer

Definition at line 242 of file types.h.

◆ Handler

template<class t_Pointer >

typedef PointerHandler<t_Pointer> ariles::NonNullPointer< t_Pointer >::Handler

Definition at line 243 of file types.h.

Constructor & Destructor Documentation

◆ NonNullPointer() [1/3]

template<class t_Pointer >

ariles::NonNullPointer< t_Pointer >::NonNullPointer ( )

inline

Definition at line 251 of file types.h.

◆ NonNullPointer() [2/3]

template<class t_Pointer >

ariles::NonNullPointer< t_Pointer >::NonNullPointer ( const t_Pointer & value )

inline

Definition at line 257 of file types.h.

◆ NonNullPointer() [3/3]

template<class t_Pointer >

ariles::NonNullPointer< t_Pointer >::NonNullPointer ( const typename Handler::Value & value )

inline

Definition at line 274 of file types.h.

◆ ~NonNullPointer()

template<class t_Pointer >

virtual ariles::NonNullPointer< t_Pointer >::~NonNullPointer ( )

inlinevirtual

Definition at line 281 of file types.h.

Member Function Documentation

◆ arilesCompare()

template<class t_Pointer >

template<class t_Other >

bool ariles::NonNullPointer< t_Pointer >::arilesCompare	(	const t_Other &	other,
		const ariles::ComparisonParameters &	param
	)		const

inline

Definition at line 341 of file types.h.

◆ arilesFinalize()

template<class t_Pointer >

void ariles::NonNullPointer< t_Pointer >::arilesFinalize ( )

inlinevirtual

Implements ariles::CommonConfigurableBase.

Definition at line 314 of file types.h.

◆ finalize()

virtual void ariles::CommonConfigurableBase::finalize ( )

inlinevirtualinherited

Reimplemented in demo::MyContainerClass.

Definition at line 87 of file ariles.h.

◆ getArilesConfigurableFlags()

virtual const ConfigurableFlags& ariles::ConfigurableBase::getArilesConfigurableFlags ( ) const

inlinevirtualinherited

Implements ariles::CommonConfigurableBase.

Definition at line 351 of file ariles.h.

◆ getConfigSectionID()

virtual const std::string& ariles::CommonConfigurableBase::getConfigSectionID ( ) const

pure virtualinherited

Return the default name of a configuration node corresponding to this class.

Returns: the name

Attention: Implementation of this method is added automatically upon inclusion of define_accessors.h if ARILES_SECTION_ID is defined.

◆ getNumberOfEntries()

template<class t_Pointer >

std::size_t ariles::NonNullPointer< t_Pointer >::getNumberOfEntries ( ) const

inlinevirtual

Get number of entries in the corresponding configuration node.

Returns: number of entries

Implements ariles::CommonConfigurableBase.

Definition at line 327 of file types.h.

◆ isNull()

template<class t_Pointer >

bool ariles::NonNullPointer< t_Pointer >::isNull ( ) const

inline

Definition at line 334 of file types.h.

◆ operator *()

template<class t_Pointer >

Handler::Value& ariles::NonNullPointer< t_Pointer >::operator * ( ) const

inline

Definition at line 293 of file types.h.

◆ operator BasePointer &()

template<class t_Pointer >

ariles::NonNullPointer< t_Pointer >::operator BasePointer & ( )

inline

Definition at line 263 of file types.h.

◆ operator const BasePointer &()

template<class t_Pointer >

ariles::NonNullPointer< t_Pointer >::operator const BasePointer & ( ) const

inline

Definition at line 268 of file types.h.

◆ operator->()

template<class t_Pointer >

Handler::Value* ariles::NonNullPointer< t_Pointer >::operator-> ( ) const

inline

Definition at line 286 of file types.h.

◆ readConfig() [1/18]

void ariles::CommonConfigurableBase::readConfig	(	ariles::ReaderBase &	reader,
		const ariles::ConfigurableFlags &	param
	)

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in] reader configuration reader

Definition at line 129 of file ariles.h.

◆ readConfig() [2/18]

void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase & reader )

inlineinherited

Definition at line 135 of file ariles.h.

◆ readConfig() [3/18]

virtual void ariles::CommonConfigurableBase::readConfig	(	ariles::ReaderBase &	reader,
		const std::string &	node_name,
		const ariles::ReaderBase::Parameters &	param
	)

pure virtualinherited

◆ readConfig() [4/18]

void ariles::CommonConfigurableBase::readConfig	(	ariles::ReaderBase &	reader,
		const std::string &	node_name
	)

inlineinherited

Definition at line 160 of file ariles.h.

◆ readConfig() [5/18]

virtual void ariles::CommonConfigurableBase::readConfig	(	ariles::ReaderBase &	reader,
		const char *	node_name,
		const ariles::ReaderBase::Parameters &	param
	)

pure virtualinherited

◆ readConfig() [6/18]

void ariles::CommonConfigurableBase::readConfig	(	ariles::ReaderBase &	reader,
		const char *	node_name
	)

inlineinherited

Definition at line 161 of file ariles.h.