#include <AbstractParameters.h>

Inheritance diagram for core::AbstractParameters:

Collaboration diagram for core::AbstractParameters:

Public Member Functions
	AbstractParameters (const std::string &name)

virtual	~AbstractParameters ()=default

virtual void	parse (const po::variables_map &)

virtual void	print ()

po::options_description &	parameters ()

Public Member Functions inherited from core::BaseObject
	BaseObject ()=default

virtual	~BaseObject ()=default

	BaseObject (const BaseObject &)

BaseObject &	operator= (const BaseObject &rhs)

bool	isModified () const

void	resetModified ()

void	markModified (const bool triggerCallback=true)

void	onModified (const ModifiedCallback &callback)

void	clearModifiedCallback ()

Static Protected Member Functions
static std::string	asString (const bool flag)

Protected Attributes
std::string	_name

po::options_description	_parameters

Additional Inherited Members
Public Types inherited from core::BaseObject
using	ModifiedCallback = std::function< void(const BaseObject &)>

Protected Member Functions inherited from core::BaseObject
template<typename T >
void	_updateValue (T &member, const T &newValue, const bool triggerCallback=true)

template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)

template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)

Detailed Description

Base class defining command line parameters

Definition at line 37 of file AbstractParameters.h.

Constructor & Destructor Documentation

◆ AbstractParameters()

core::AbstractParameters::AbstractParameters ( const std::string & name )

inline

Constructor

Parameters

name	Display name for the set of parameters

Definition at line 44 of file AbstractParameters.h.

◆ ~AbstractParameters()

virtual core::AbstractParameters::~AbstractParameters ( )

virtualdefault

Member Function Documentation

◆ asString()

static std::string core::AbstractParameters::asString ( const bool flag )

inlinestaticprotected

Definition at line 69 of file AbstractParameters.h.

◆ parameters()

po::options_description& core::AbstractParameters::parameters ( )

inline

Definition at line 62 of file AbstractParameters.h.

◆ parse()

virtual void core::AbstractParameters::parse ( const po::variables_map & )

inlinevirtual

Parses parameters managed by the class

Parameters

vm	the variables map of all arguments passed by the user

Reimplemented in core::VolumeParameters, core::RenderingParameters, core::GeometryParameters, core::FieldParameters, and core::ApplicationParameters.

Definition at line 55 of file AbstractParameters.h.

◆ print()

void core::AbstractParameters::print ( )

virtual

Displays values of registered parameters

Reimplemented in core::VolumeParameters, core::RenderingParameters, core::GeometryParameters, core::FieldParameters, core::ApplicationParameters, and core::AnimationParameters.

Definition at line 27 of file AbstractParameters.cpp.

Member Data Documentation

◆ _name

std::string core::AbstractParameters::_name

protected

Definition at line 65 of file AbstractParameters.h.

◆ _parameters

po::options_description core::AbstractParameters::_parameters

protected

Definition at line 67 of file AbstractParameters.h.

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

platform/core/parameters/AbstractParameters.h
platform/core/parameters/AbstractParameters.cpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members