www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
RestartableDataValue Class Referenceabstract

Abstract definition of a RestartableData value. More...

#include <RestartableData.h>

Inheritance diagram for RestartableDataValue:
[legend]

Public Member Functions

 RestartableDataValue (std::string name, void *context)
 Constructor. More...
 
virtual ~RestartableDataValue ()=default
 Destructor. More...
 
virtual std::string type ()=0
 String identifying the type of parameter stored. 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...
 
virtual void swap (RestartableDataValue *rhs)=0
 
virtual void store (std::ostream &stream)=0
 
virtual void load (std::istream &stream)=0
 

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...
 

Detailed Description

Abstract definition of a RestartableData value.

Definition at line 25 of file RestartableData.h.

Constructor & Destructor Documentation

◆ RestartableDataValue()

RestartableDataValue::RestartableDataValue ( std::string  name,
void *  context 
)
inline

Constructor.

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

Definition at line 33 of file RestartableData.h.

33 : _name(name), _context(context) {}
void * _context
A context pointer for helping with load and store.
std::string _name
The full (unique) name of this particular piece of data.
void * context()
A context pointer for helping with load / store.
std::string name()
The full (unique) name of this particular piece of data.

◆ ~RestartableDataValue()

virtual RestartableDataValue::~RestartableDataValue ( )
virtualdefault

Destructor.

Member Function Documentation

◆ context()

void* RestartableDataValue::context ( )
inline

A context pointer for helping with load / store.

Definition at line 54 of file RestartableData.h.

54 { return _context; }
void * _context
A context pointer for helping with load and store.

◆ load()

virtual void RestartableDataValue::load ( std::istream &  stream)
pure virtual

Implemented in RestartableData< T >.

◆ name()

std::string RestartableDataValue::name ( )
inline

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

Definition at line 49 of file RestartableData.h.

49 { return _name; }
std::string _name
The full (unique) name of this particular piece of data.

◆ store()

virtual void RestartableDataValue::store ( std::ostream &  stream)
pure virtual

Implemented in RestartableData< T >.

◆ swap()

virtual void RestartableDataValue::swap ( RestartableDataValue rhs)
pure virtual

Implemented in RestartableData< T >.

◆ type()

virtual std::string RestartableDataValue::type ( )
pure virtual

String identifying the type of parameter stored.

Must be reimplemented in derived classes.

Implemented in RestartableData< T >.

Member Data Documentation

◆ _context

void* RestartableDataValue::_context
protected

A context pointer for helping with load and store.

Definition at line 67 of file RestartableData.h.

Referenced by context().

◆ _name

std::string RestartableDataValue::_name
protected

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

Definition at line 64 of file RestartableData.h.

Referenced by name().


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