gpu_coverage::Config::AbstractParam Struct Reference

Abstract class representing a configuration parameter. More...

#include <Config.h>

Inheritance diagram for gpu_coverage::Config::AbstractParam:

Public Member Functions
virtual void	write (std::ostream &os) const =0
	Write this parameter to a configuration file output stream. More...
virtual void	read (std::istream &is)=0
	Read this parameter from a configuration file input stream. More...
	AbstractParam (const std::string &name, const std::string &description)
	Constructor. More...
virtual	~AbstractParam ()
	Destructor.

Public Attributes
const std::string	name
	The name of the descriptor.
const std::string	description
	A human-readable description of the parameter.

Friends
std::ostream &	operator<< (std::ostream &os, AbstractParam &param)
	Stream operator for writing this parameter to a config data stream. More...
std::istream &	operator>> (std::istream &is, AbstractParam &param)
	Stream operator for reading this parameter from a config data stream. More...

Detailed Description

Abstract class representing a configuration parameter.

Constructor & Destructor Documentation

gpu_coverage::Config::AbstractParam::AbstractParam ( const std::string &  name, const std::string &  description  )

inline

Constructor.

Parameters

[in]	name	The name of the parameter.
[in]	description	A human-readable description of the parameter.

Member Function Documentation

virtual void gpu_coverage::Config::AbstractParam::read ( std::istream &  is )

pure virtual

Read this parameter from a configuration file input stream.

Parameters

[in]

is

The input stream to read from.

Implemented in gpu_coverage::Config::Param< T >.

virtual void gpu_coverage::Config::AbstractParam::write ( std::ostream &  os ) const

pure virtual

Write this parameter to a configuration file output stream.

Parameters

[in]

os

The output stream to write to.

Implemented in gpu_coverage::Config::Param< T >.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, AbstractParam &  param  )

friend

Stream operator for writing this parameter to a config data stream.

Parameters

[in]	os	Output stream.
[in]	param	The parameter to write.

Returns

The output stream for chaining.

std::istream& operator>> ( std::istream &  is, AbstractParam &  param  )

friend

Stream operator for reading this parameter from a config data stream.

Parameters

[in]	is	Input stream.
[in]	param	The parameter to read.

Returns

The input stream for chaining.

---

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

• include/gpu_coverage/Config.h