https://mooseframework.inl.gov
Public Member Functions | Private Attributes | List of all members
Moose::WebServerControlTypeRegistry::ControlledValueBase Class Referenceabstract

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

#include <WebServerControlTypeRegistry.h>

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

Public Member Functions

 ControlledValueBase (const std::string &name, const std::string &type)
 Constructor. More...
 
virtual ~ControlledValueBase ()
 
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 44 of file WebServerControlTypeRegistry.h.

Constructor & Destructor Documentation

◆ ControlledValueBase()

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

Constructor.

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

Definition at line 48 of file WebServerControlTypeRegistry.C.

◆ ~ControlledValueBase()

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

Definition at line 54 of file WebServerControlTypeRegistry.h.

54 {}

Member Function Documentation

◆ name()

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

Definition at line 59 of file WebServerControlTypeRegistry.h.

Referenced by WebServerControl::ControlledValue< T >::setControllableValue().

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

◆ setControllableValue()

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

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

Will broadcast the value and set it in the derived, type-aware class.

Implemented in WebServerControl::ControlledValue< T >.

◆ type()

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

Definition at line 63 of file WebServerControlTypeRegistry.h.

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

Member Data Documentation

◆ _name

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

The name that the value is for.

Definition at line 75 of file WebServerControlTypeRegistry.h.

Referenced by name().

◆ _type

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

The string representation of the type.

Definition at line 77 of file WebServerControlTypeRegistry.h.

Referenced by type().


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