RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Friends | List of all members
rstudio::launcher_plugins::options::Value< T > Class Template Reference

Concrete class which represents an option Value. More...

#include <Options.hpp>

Public Member Functions

 Value ()
 Default Constructor.
 
 Value (T &io_storeTo)
 Constructor which takes an object to store the value to. More...
 
ValuesetDefaultValue (const T &in_defaultValue)
 Sets the default value of the option. More...
 

Friends

class Options
 

Detailed Description

template<class T>
class rstudio::launcher_plugins::options::Value< T >

Concrete class which represents an option Value.

This class supports the following template types:

If a custom type is needed, treat the option value as a string and do the parsing and conversion from the string value.

Template Parameters
TThe type of the option value.

Constructor & Destructor Documentation

◆ Value()

template<class T>
rstudio::launcher_plugins::options::Value< T >::Value ( T &  io_storeTo)
explicit

Constructor which takes an object to store the value to.

Parameters
io_storeToThe object to store the option value to. The caller is responsible for ensuring that this object is alive when the option file is parsed.

Member Function Documentation

◆ setDefaultValue()

template<class T>
Value& rstudio::launcher_plugins::options::Value< T >::setDefaultValue ( const T &  in_defaultValue)

Sets the default value of the option.

Parameters
in_defaultValueThe default value of the option.
Returns
A reference to this value.

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