WebServerControl::RealEigenMatrixValue Class Reference

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

#include <WebServerControl.h>

Inheritance diagram for WebServerControl::RealEigenMatrixValue:

Public Types
using	value_type = RealEigenMatrix
	The underlying type of the value. More...

Public Member Functions
	RealEigenMatrixValue (const std::string &name, const std::string &type)
	RealEigenMatrixValue (const std::string &name, const std::string &type, const miniJson::Json &json_value)
const RealEigenMatrix &	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 RealEigenMatrix	getMatrixJSONValue (const miniJson::Json &json_value)

Detailed Description

Class that stores a RealEigenMatrix controllable value to be set.

Definition at line 148 of file WebServerControl.h.

Member Typedef Documentation

value_type

using WebServerControl::TypedValueBase< RealEigenMatrix >::value_type = RealEigenMatrix

inherited

The underlying type of the value.

Definition at line 76 of file WebServerControl.h.

Constructor & Destructor Documentation

RealEigenMatrixValue() [1/2]

WebServerControl::RealEigenMatrixValue::RealEigenMatrixValue	(	const std::string &	name,
		const std::string &	type
	)

Definition at line 453 of file WebServerControl.C.

  : TypedValueBase<RealEigenMatrix>(name, type)
{
}

RealEigenMatrixValue() [2/2]

WebServerControl::RealEigenMatrixValue::RealEigenMatrixValue	(	const std::string &	name,
		const std::string &	type,
		const miniJson::Json &	json_value
	)

Definition at line 459 of file WebServerControl.C.

  : TypedValueBase<RealEigenMatrix>(name, type, getMatrixJSONValue(json_value))
{
}

Member Function Documentation

getMatrixJSONValue()

RealEigenMatrix WebServerControl::RealEigenMatrixValue::getMatrixJSONValue ( const miniJson::Json &  json_value )

static

Definition at line 467 of file WebServerControl.C.

{
  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_of_array_value = json_value.toArray();
  const auto nrows = array_of_array_value.size();
  if (nrows == 0)
    return RealEigenMatrix::Zero(0, 0);

  RealEigenMatrix matrix;
  for (const auto i : make_range(nrows))
  {
    if (array_of_array_value[i].getType() != miniJson::JsonType::kArray)
      throw ValueBase::Exception(
          "Element " + std::to_string(i) + " of '" + json_value.serialize() + "' of type " +
          stringifyJSONType(array_of_array_value[i].getType()) + " is not an array");

    const auto & array_value = array_of_array_value[i].toArray();
    if (i == 0)
      matrix.resize(nrows, array_value.size());
    else if (array_value.size() != (std::size_t)matrix.cols())
      throw ValueBase::Exception("The matrix '" + json_value.serialize() + "' is jagged.");

    for (const auto j : index_range(array_value))
      matrix(i, j) = array_value[j].toDouble();
  }

  return matrix;
}

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< RealEigenMatrix >::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 RealEigenMatrix & WebServerControl::TypedValueBase< RealEigenMatrix >::value ( ) const

inlineinherited

Returns

The underlying value

Definition at line 81 of file WebServerControl.h.

{ return _value; }

---

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

• include/controls/WebServerControl.h
• src/controls/WebServerControl.C