WebServerControl::VectorValue< T, json_type > Class Template Reference

Class that stores a vector controllable value to be set. More...

#include <WebServerControl.h>

Inheritance diagram for WebServerControl::VectorValue< T, json_type >:

Public Types
using	value_type = std::vector< T >
	The underlying type of the value. More...

Public Member Functions
	VectorValue (const std::string &name, const std::string &type)
	VectorValue (const std::string &name, const std::string &type, const miniJson::Json &json_value)
const std::vector< T > &	value () const
virtual void	setControllableValue (WebServerControl &control) override final
	Sets the controllable value given the name and type via the controllable interface in control. More...
const std::string &	name () const
const std::string &	type () const

Static Public Member Functions
static std::vector< T >	getVectorJSONValue (const miniJson::Json &json_value)

Detailed Description

template<typename T, miniJson::JsonType json_type>
class WebServerControl::VectorValue< T, json_type >

Class that stores a vector controllable value to be set.

Definition at line 116 of file WebServerControl.h.

Member Typedef Documentation

value_type

using WebServerControl::TypedValueBase< std::vector< T > >::value_type = std::vector< T >

inherited

The underlying type of the value.

Definition at line 76 of file WebServerControl.h.

Constructor & Destructor Documentation

VectorValue() [1/2]

template<typename T , miniJson::JsonType json_type>

WebServerControl::VectorValue< T, json_type >::VectorValue ( const std::string &  name, const std::string &  type  )

inline

Definition at line 119 of file WebServerControl.h.

      : TypedValueBase<std::vector<T>>(name, type)
    {
    }

VectorValue() [2/2]

template<typename T , miniJson::JsonType json_type>

WebServerControl::VectorValue< T, json_type >::VectorValue ( const std::string &  name, const std::string &  type, const miniJson::Json &  json_value  )

inline

Definition at line 123 of file WebServerControl.h.

      : TypedValueBase<std::vector<T>>(name, type, getVectorJSONValue(json_value))
    {
    }

Member Function Documentation

getVectorJSONValue()

template<typename T , miniJson::JsonType json_type>

static std::vector<T> WebServerControl::VectorValue< T, json_type >::getVectorJSONValue ( const miniJson::Json &  json_value )

inlinestatic

Definition at line 130 of file WebServerControl.h.

    {
      const auto from_json_type = json_value.getType();
      if (from_json_type != miniJson::JsonType::kArray)
        throw ValueBase::Exception("The value '" + json_value.serialize() + "' of type " +
                                   stringifyJSONType(from_json_type) + " is not an array");

      const auto & array_value = json_value.toArray();
      std::vector<T> value(array_value.size());
      for (const auto i : index_range(array_value))
        value[i] = getScalarJSONValue<T, json_type>(array_value[i]);
      return value;
    }

name()

const std::string& Moose::WebServerControlTypeRegistry::ValueBase::name ( ) const

inlineinherited

Returns

The name that the value is for

Definition at line 57 of file WebServerControlTypeRegistry.h.

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

{ return _name; }

setControllableValue()

virtual void WebServerControl::TypedValueBase< std::vector< T > >::setControllableValue ( WebServerControl &  control )

inlinefinaloverridevirtualinherited

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

Will broadcast the value for setting it.

Implements Moose::WebServerControlTypeRegistry::ValueBase.

Definition at line 83 of file WebServerControl.h.

    {
      control.comm().broadcast(_value);
      control.setControllableValueByName<T>(name(), value());
    }

type()

const std::string& Moose::WebServerControlTypeRegistry::ValueBase::type ( ) const

inlineinherited

Returns

The string representation of the type

Definition at line 61 of file WebServerControlTypeRegistry.h.

{ return _type; }

value()

const std::vector< T > & WebServerControl::TypedValueBase< std::vector< T > >::value ( ) const

inlineinherited

Returns

The underlying value

Definition at line 81 of file WebServerControl.h.

Referenced by WebServerControl::VectorValue< T, json_type >::getVectorJSONValue().

{ return _value; }

---

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

• include/controls/WebServerControl.h