#include <ApplicationParameters.h>

Inheritance diagram for core::ApplicationParameters:

Collaboration diagram for core::ApplicationParameters:

Public Member Functions
	ApplicationParameters ()

void	print () final

const std::string &	getEngine () const

const std::vector< std::string > &	getOsprayModules () const

bool	getDynamicLoadBalancer () const

void	setDynamicLoadBalancer (const bool value)

const Vector2ui	getWindowSize () const

void	setWindowSize (const Vector2ui &size)

bool	isBenchmarking () const

void	setBenchmarking (bool enabled)

void	setJpegCompression (const size_t compression)

size_t	getJpegCompression () const

size_t	getImageStreamFPS () const

void	setImageStreamFPS (const size_t fps)

bool	useVideoStreaming () const

size_t	getMaxRenderFPS () const

bool	isStereo () const

bool	getParallelRendering () const

const std::string &	getHttpServerURI () const

void	setHttpServerURI (const std::string &httpServerURI)

const std::string &	getEnvMap () const

const std::string &	getSandboxPath () const

const strings &	getInputPaths () const

po::positional_options_description &	posArgs ()

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

virtual	~AbstractParameters ()=default

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 ()

Protected Member Functions
void	parse (const po::variables_map &vm) final

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)

Protected Attributes
std::string	_engine {ENGINE_OSPRAY}

std::vector< std::string >	_modules

Vector2d	_windowSize

bool	_benchmarking {false}

size_t	_jpegCompression

bool	_stereo {false}

size_t	_imageStreamFPS {60}

size_t	_maxRenderFPS {std::numeric_limits<size_t>::max()}

std::string	_httpServerURI

bool	_parallelRendering {false}

bool	_dynamicLoadBalancer {false}

bool	_useVideoStreaming {false}

std::string	_envMap

std::string	_sandBoxPath

strings	_inputPaths

po::positional_options_description	_positionalArgs

Protected Attributes inherited from core::AbstractParameters
std::string	_name

po::options_description	_parameters

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

Static Protected Member Functions inherited from core::AbstractParameters
static std::string	asString (const bool flag)

Detailed Description

Manages application parameters

Definition at line 37 of file ApplicationParameters.h.

Constructor & Destructor Documentation

◆ ApplicationParameters()

core::ApplicationParameters::ApplicationParameters ( )

Definition at line 54 of file ApplicationParameters.cpp.

Member Function Documentation

◆ getDynamicLoadBalancer()

bool core::ApplicationParameters::getDynamicLoadBalancer ( ) const

inline

Definition at line 50 of file ApplicationParameters.h.

◆ getEngine()

const std::string& core::ApplicationParameters::getEngine ( ) const

inline

Engine

Definition at line 46 of file ApplicationParameters.h.

◆ getEnvMap()

const std::string& core::ApplicationParameters::getEnvMap ( ) const

inline

Definition at line 78 of file ApplicationParameters.h.

◆ getHttpServerURI()

const std::string& core::ApplicationParameters::getHttpServerURI ( ) const

inline

Definition at line 75 of file ApplicationParameters.h.

◆ getImageStreamFPS()

size_t core::ApplicationParameters::getImageStreamFPS ( ) const

inline

Image stream FPS

Definition at line 67 of file ApplicationParameters.h.

◆ getInputPaths()

const strings& core::ApplicationParameters::getInputPaths ( ) const

inline

Definition at line 80 of file ApplicationParameters.h.

◆ getJpegCompression()

size_t core::ApplicationParameters::getJpegCompression ( ) const

inline

Definition at line 65 of file ApplicationParameters.h.

◆ getMaxRenderFPS()

size_t core::ApplicationParameters::getMaxRenderFPS ( ) const

inline

Max render FPS to limit

Definition at line 72 of file ApplicationParameters.h.

◆ getOsprayModules()

const std::vector<std::string>& core::ApplicationParameters::getOsprayModules ( ) const

inline

OSPRay modules

Definition at line 48 of file ApplicationParameters.h.

◆ getParallelRendering()

bool core::ApplicationParameters::getParallelRendering ( ) const

inline

Definition at line 74 of file ApplicationParameters.h.

◆ getSandboxPath()

const std::string& core::ApplicationParameters::getSandboxPath ( ) const

inline

Definition at line 79 of file ApplicationParameters.h.

◆ getWindowSize()

const Vector2ui core::ApplicationParameters::getWindowSize ( ) const

inline

window size

Definition at line 54 of file ApplicationParameters.h.

◆ isBenchmarking()

bool core::ApplicationParameters::isBenchmarking ( ) const

inline

Benchmarking

Definition at line 61 of file ApplicationParameters.h.

◆ isStereo()

bool core::ApplicationParameters::isStereo ( ) const

inline

Definition at line 73 of file ApplicationParameters.h.

◆ parse()

void core::ApplicationParameters::parse ( const po::variables_map & )

finalprotectedvirtual

Parses parameters managed by the class

Parameters

vm	the variables map of all arguments passed by the user

Reimplemented from core::AbstractParameters.

Definition at line 100 of file ApplicationParameters.cpp.

◆ posArgs()

po::positional_options_description& core::ApplicationParameters::posArgs ( )

inline

Definition at line 81 of file ApplicationParameters.h.

◆ print()

void core::ApplicationParameters::print ( )

finalvirtual

Displays values of registered parameters

Reimplemented from core::AbstractParameters.

Definition at line 111 of file ApplicationParameters.cpp.

◆ setBenchmarking()

void core::ApplicationParameters::setBenchmarking ( bool enabled )

inline

Definition at line 62 of file ApplicationParameters.h.

◆ setDynamicLoadBalancer()

void core::ApplicationParameters::setDynamicLoadBalancer ( const bool value )

inline

Definition at line 51 of file ApplicationParameters.h.

◆ setHttpServerURI()

void core::ApplicationParameters::setHttpServerURI ( const std::string & httpServerURI )

inline

Definition at line 76 of file ApplicationParameters.h.

◆ setImageStreamFPS()

void core::ApplicationParameters::setImageStreamFPS ( const size_t fps )

inline

Definition at line 68 of file ApplicationParameters.h.

◆ setJpegCompression()

void core::ApplicationParameters::setJpegCompression ( const size_t compression )

inline

JPEG compression quality

Definition at line 64 of file ApplicationParameters.h.

◆ setWindowSize()

void core::ApplicationParameters::setWindowSize ( const Vector2ui & size )

inline

Definition at line 55 of file ApplicationParameters.h.

◆ useVideoStreaming()

bool core::ApplicationParameters::useVideoStreaming ( ) const

inline

Definition at line 70 of file ApplicationParameters.h.

Member Data Documentation

◆ _benchmarking

bool core::ApplicationParameters::_benchmarking {false}

protected

Definition at line 89 of file ApplicationParameters.h.

◆ _dynamicLoadBalancer

bool core::ApplicationParameters::_dynamicLoadBalancer {false}

protected

Definition at line 96 of file ApplicationParameters.h.

◆ _engine

std::string core::ApplicationParameters::_engine {ENGINE_OSPRAY}

protected

Definition at line 86 of file ApplicationParameters.h.

◆ _envMap

std::string core::ApplicationParameters::_envMap

protected

Definition at line 98 of file ApplicationParameters.h.

◆ _httpServerURI

std::string core::ApplicationParameters::_httpServerURI

protected

Definition at line 94 of file ApplicationParameters.h.

◆ _imageStreamFPS

size_t core::ApplicationParameters::_imageStreamFPS {60}

protected

Definition at line 92 of file ApplicationParameters.h.

◆ _inputPaths

strings core::ApplicationParameters::_inputPaths

protected

Definition at line 101 of file ApplicationParameters.h.

◆ _jpegCompression

size_t core::ApplicationParameters::_jpegCompression

protected

Definition at line 90 of file ApplicationParameters.h.

◆ _maxRenderFPS

size_t core::ApplicationParameters::_maxRenderFPS {std::numeric_limits<size_t>::max()}

protected

Definition at line 93 of file ApplicationParameters.h.

◆ _modules

std::vector<std::string> core::ApplicationParameters::_modules

protected

Definition at line 87 of file ApplicationParameters.h.

◆ _parallelRendering

bool core::ApplicationParameters::_parallelRendering {false}

protected

Definition at line 95 of file ApplicationParameters.h.

◆ _positionalArgs

po::positional_options_description core::ApplicationParameters::_positionalArgs

protected

Definition at line 103 of file ApplicationParameters.h.

◆ _sandBoxPath

std::string core::ApplicationParameters::_sandBoxPath

protected

Definition at line 99 of file ApplicationParameters.h.

◆ _stereo

bool core::ApplicationParameters::_stereo {false}

protected

Definition at line 91 of file ApplicationParameters.h.

◆ _useVideoStreaming

bool core::ApplicationParameters::_useVideoStreaming {false}

protected

Definition at line 97 of file ApplicationParameters.h.

◆ _windowSize

Vector2d core::ApplicationParameters::_windowSize

protected

Definition at line 88 of file ApplicationParameters.h.

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

platform/core/parameters/ApplicationParameters.h
platform/core/parameters/ApplicationParameters.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ApplicationParameters()

Member Function Documentation

◆ getDynamicLoadBalancer()

◆ getEngine()

◆ getEnvMap()

◆ getHttpServerURI()

◆ getImageStreamFPS()

◆ getInputPaths()

◆ getJpegCompression()

◆ getMaxRenderFPS()

◆ getOsprayModules()

◆ getParallelRendering()

◆ getSandboxPath()

◆ getWindowSize()

◆ isBenchmarking()

◆ isStereo()

◆ parse()

◆ posArgs()

◆ print()

◆ setBenchmarking()

◆ setDynamicLoadBalancer()

◆ setHttpServerURI()

◆ setImageStreamFPS()

◆ setJpegCompression()

◆ setWindowSize()

◆ useVideoStreaming()

Member Data Documentation

◆ _benchmarking

◆ _dynamicLoadBalancer

◆ _engine

◆ _envMap

◆ _httpServerURI

◆ _imageStreamFPS

◆ _inputPaths

◆ _jpegCompression

◆ _maxRenderFPS

◆ _modules

◆ _parallelRendering

◆ _positionalArgs

◆ _sandBoxPath

◆ _stereo

◆ _useVideoStreaming

◆ _windowSize