RestartableData< T > Class Template Reference

Concrete definition of a parameter value for a specified type. More...

#include <RestartableData.h>

Inheritance diagram for RestartableData< T >:

Public Member Functions
	RestartableData (std::string name, void *context)
	Constructor. More...
T &	get ()
T &	set ()
virtual std::string	type () override
	String identifying the type of parameter stored. More...
virtual void	swap (RestartableDataValue *rhs) override
	Swap. More...
virtual void	store (std::ostream &stream) override
	Store the RestartableData into a binary stream. More...
virtual void	load (std::istream &stream) override
	Load the RestartableData from a binary stream. More...
std::string	name ()
	The full (unique) name of this particular piece of data. More...
void *	context ()
	A context pointer for helping with load / store. More...

Protected Attributes
std::string	_name
	The full (unique) name of this particular piece of data. More...
void *	_context
	A context pointer for helping with load and store. More...

Private Attributes
std::unique_ptr< T >	_value_ptr
	Stored value. More...

Detailed Description

template<typename T>
class RestartableData< T >

Concrete definition of a parameter value for a specified type.

Definition at line 76 of file RestartableData.h.

Constructor & Destructor Documentation

RestartableData()

template<typename T >

RestartableData< T >::RestartableData ( std::string  name, void *  context  )

inline

Constructor.

Parameters

name	The full (unique) name for this piece of data.
context	'typeless' pointer to user-specific data.

Definition at line 84 of file RestartableData.h.

                                                  : RestartableDataValue(name, context)
  {
    _value_ptr = libmesh_make_unique<T>();
  }

Member Function Documentation

context()

void* RestartableDataValue::context ( )

inlineinherited

A context pointer for helping with load / store.

Definition at line 55 of file RestartableData.h.

{ return _context; }

get()

template<typename T >

T& RestartableData< T >::get ( )

inline

Returns

a read-only reference to the parameter value.

Definition at line 92 of file RestartableData.h.

{ return *_value_ptr; }

Referenced by MeshGenerator::declareMeshProperty(), Restartable::declareRestartableDataWithContext(), and MeshMetaDataInterface::getMeshProperty().

load()

template<typename T >

void RestartableData< T >::load ( std::istream &  stream )

inlineoverridevirtual

Load the RestartableData from a binary stream.

Implements RestartableDataValue.

Definition at line 151 of file RestartableData.h.

{
  loadHelper(stream, *_value_ptr, _context);
}

name()

std::string RestartableDataValue::name ( )

inlineinherited

The full (unique) name of this particular piece of data.

Definition at line 50 of file RestartableData.h.

{ return _name; }

set()

template<typename T >

T& RestartableData< T >::set ( )

inline

Returns

a writable reference to the parameter value.

Definition at line 97 of file RestartableData.h.

{ return *_value_ptr; }

Referenced by Restartable::declareRestartableDataWithContext().

store()

template<typename T >

void RestartableData< T >::store ( std::ostream &  stream )

inlineoverridevirtual

Store the RestartableData into a binary stream.

Implements RestartableDataValue.

Definition at line 143 of file RestartableData.h.

{
  T & tmp = *_value_ptr;
  storeHelper(stream, tmp, _context);
}

swap()

template<typename T >

void RestartableData< T >::swap ( RestartableDataValue *  rhs )

inlineoverridevirtual

Swap.

Implements RestartableDataValue.

Definition at line 135 of file RestartableData.h.

{
  mooseAssert(rhs, "Assigning NULL?");
  //  _value.swap(cast_ptr<RestartableData<T>*>(rhs)->_value);
}

type()

template<typename T >

std::string RestartableData< T >::type ( )

inlineoverridevirtual

String identifying the type of parameter stored.

Implements RestartableDataValue.

Definition at line 128 of file RestartableData.h.

{
  return typeid(T).name();
}

Member Data Documentation

_context

void* RestartableDataValue::_context

protectedinherited

A context pointer for helping with load and store.

Definition at line 68 of file RestartableData.h.

Referenced by RestartableDataValue::context().

_name

std::string RestartableDataValue::_name

protectedinherited

The full (unique) name of this particular piece of data.

Definition at line 65 of file RestartableData.h.

Referenced by RestartableDataValue::name().

_value_ptr

template<typename T >

std::unique_ptr<T> RestartableData< T >::_value_ptr

private

Stored value.

Definition at line 121 of file RestartableData.h.

Referenced by RestartableData< T >::get(), RestartableData< T >::RestartableData(), and RestartableData< T >::set().

---

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

• include/restart/RestartableData.h