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

Base registry class for a type that is used to build values. More...

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

Public Member Functions

 TypeBase (const std::string &type)
 
virtual ~TypeBase ()
 
const std::string & type () const
 
virtual std::unique_ptr< ValueBasebuild (const std::string &name, const miniJson::Json &json_value) const =0
 Builds a value with the given type, name name, and JSON value json_value. More...
 
virtual std::unique_ptr< ValueBasebuild (const std::string &name) const =0
 Builds a value with the given type, name name, and a default value. More...
 

Private Attributes

const std::string _type
 The string representation of the underlying type. More...
 

Detailed Description

Base registry class for a type that is used to build values.

Definition at line 127 of file WebServerControlTypeRegistry.h.

Constructor & Destructor Documentation

◆ TypeBase()

Moose::WebServerControlTypeRegistry::TypeBase::TypeBase ( const std::string &  type)
inline

Definition at line 130 of file WebServerControlTypeRegistry.h.

130 : _type(type) {}
const std::string _type
The string representation of the underlying type.

◆ ~TypeBase()

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

Definition at line 131 of file WebServerControlTypeRegistry.h.

131 {}

Member Function Documentation

◆ build() [1/2]

virtual std::unique_ptr<ValueBase> Moose::WebServerControlTypeRegistry::TypeBase::build ( const std::string &  name,
const miniJson::Json &  json_value 
) const
pure virtual

Builds a value with the given type, name name, and JSON value json_value.

This will parse the JSON value into the underlying type and will be called on only rank 0 where server listens.

Implemented in Moose::WebServerControlTypeRegistry::Type< DerivedValueType >.

◆ build() [2/2]

virtual std::unique_ptr<ValueBase> Moose::WebServerControlTypeRegistry::TypeBase::build ( const std::string &  name) const
pure virtual

Builds a value with the given type, name name, and a default value.

This will be called on processors that are not rank 0 for cloning.

Implemented in Moose::WebServerControlTypeRegistry::Type< DerivedValueType >.

◆ type()

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

Definition at line 136 of file WebServerControlTypeRegistry.h.

Referenced by Moose::WebServerControlTypeRegistry::Type< DerivedValueType >::build().

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

Member Data Documentation

◆ _type

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

The string representation of the underlying type.

Definition at line 154 of file WebServerControlTypeRegistry.h.

Referenced by type().


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