Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Classes | Public Member Functions | Private Attributes | List of all members
Moose::WebServerControlTypeRegistry::ValueBase Class Referenceabstract

The base class for a value that is produced by this registry. More...

#include <WebServerControlTypeRegistry.h>

Inheritance diagram for Moose::WebServerControlTypeRegistry::ValueBase:
[legend]

Classes

struct  Exception
 Common exception for parsing related errors in converting JSON to a value. More...
 

Public Member Functions

 ValueBase (const std::string &name, const std::string &type)
 Constructor. More...
 
virtual ~ValueBase ()
 
const std::string & name () const
 
const std::string & type () const
 
virtual void setControllableValue (WebServerControl &control)=0
 Sets the controllable value given the name and type via the controllable interface in control. More...
 

Private Attributes

const std::string _name
 The name that the value is for. More...
 
const std::string _type
 The string representation of the type. More...
 

Detailed Description

The base class for a value that is produced by this registry.

Definition at line 41 of file WebServerControlTypeRegistry.h.

Constructor & Destructor Documentation

◆ ValueBase()

Moose::WebServerControlTypeRegistry::ValueBase::ValueBase ( const std::string &  name,
const std::string &  type 
)
inline

Constructor.

Parameters
nameThe name that the value is for (typically a controllable path)
typeThe string representationg of the type

Definition at line 49 of file WebServerControlTypeRegistry.h.

49 : _name(name), _type(type) {}
const std::string _name
The name that the value is for.
const std::string _type
The string representation of the type.

◆ ~ValueBase()

virtual Moose::WebServerControlTypeRegistry::ValueBase::~ValueBase ( )
inlinevirtual

Definition at line 50 of file WebServerControlTypeRegistry.h.

50 {}

Member Function Documentation

◆ name()

const std::string& Moose::WebServerControlTypeRegistry::ValueBase::name ( ) const
inline
Returns
The name that the value is for

Definition at line 55 of file WebServerControlTypeRegistry.h.

Referenced by WebServerControl::TypedValueBase< std::vector< T > >::setControllableValue().

55 { return _name; }
const std::string _name
The name that the value is for.

◆ setControllableValue()

virtual void Moose::WebServerControlTypeRegistry::ValueBase::setControllableValue ( WebServerControl control)
pure virtual

Sets the controllable value given the name and type via the controllable interface in control.

Will broadcast the value for setting it.

Implemented in WebServerControl::TypedValueBase< T >, and WebServerControl::TypedValueBase< std::vector< T > >.

◆ type()

const std::string& Moose::WebServerControlTypeRegistry::ValueBase::type ( ) const
inline
Returns
The string representation of the type

Definition at line 59 of file WebServerControlTypeRegistry.h.

59 { return _type; }
const std::string _type
The string representation of the type.

Member Data Documentation

◆ _name

const std::string Moose::WebServerControlTypeRegistry::ValueBase::_name
private

The name that the value is for.

Definition at line 84 of file WebServerControlTypeRegistry.h.

Referenced by name().

◆ _type

const std::string Moose::WebServerControlTypeRegistry::ValueBase::_type
private

The string representation of the type.

Definition at line 86 of file WebServerControlTypeRegistry.h.

Referenced by type().


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