Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
PLMD::DataFetchingObject Class Referenceabstract

#include <DataFetchingObject.h>

Inheritance diagram for PLMD::DataFetchingObject:
Inheritance graph
[legend]

Public Member Functions

 DataFetchingObject (PlumedMain &p)
 A constructor so that we can create the plumed main object. More...
 
virtual ~DataFetchingObject ()
 
bool activate () const
 
virtual void finishDataGrab ()=0
 After calc has been performed grab all the data and put it in the relevant arrays. More...
 
virtual void setData (const std::string &key, const std::string &type, void *outval)=0
 Set the pointer to the data. More...
 

Static Public Member Functions

static std::unique_ptr< DataFetchingObjectcreate (unsigned n, PlumedMain &p)
 
static ActionWithValuefindAction (const ActionSet &a, const std::string &key)
 Find the action that calculates a particular value. More...
 
static void get_rank (const ActionSet &a, const std::string &key, const std::string &type, long *rank)
 Return the rank required for a particular key. More...
 
static void get_shape (const ActionSet &a, const std::string &key, const std::string &type, long *dims)
 Return the shape required for a particular key. More...
 

Protected Attributes

std::vector< ActionWithValue * > myactions
 Pointers to the various actions required by the grabber. More...
 
std::vector< Value * > myvalues
 The values required by the user. More...
 
PlumedMainplumed
 A copy of the plumed main object. More...
 

Constructor & Destructor Documentation

◆ DataFetchingObject()

PLMD::DataFetchingObject::DataFetchingObject ( PlumedMain p)
explicit

A constructor so that we can create the plumed main object.

◆ ~DataFetchingObject()

virtual PLMD::DataFetchingObject::~DataFetchingObject ( )
inlinevirtual

Member Function Documentation

◆ activate()

bool PLMD::DataFetchingObject::activate ( ) const

◆ create()

std::unique_ptr< DataFetchingObject > PLMD::DataFetchingObject::create ( unsigned  n,
PlumedMain p 
)
static

◆ findAction()

ActionWithValue * PLMD::DataFetchingObject::findAction ( const ActionSet a,
const std::string &  key 
)
static

Find the action that calculates a particular value.

◆ finishDataGrab()

virtual void PLMD::DataFetchingObject::finishDataGrab ( )
pure virtual

After calc has been performed grab all the data and put it in the relevant arrays.

Implemented in PLMD::DataFetchingObjectTyped< T >.

◆ get_rank()

void PLMD::DataFetchingObject::get_rank ( const ActionSet a,
const std::string &  key,
const std::string &  type,
long *  rank 
)
static

Return the rank required for a particular key.

◆ get_shape()

void PLMD::DataFetchingObject::get_shape ( const ActionSet a,
const std::string &  key,
const std::string &  type,
long *  dims 
)
static

Return the shape required for a particular key.

◆ setData()

virtual void PLMD::DataFetchingObject::setData ( const std::string &  key,
const std::string &  type,
void *  outval 
)
pure virtual

Set the pointer to the data.

Implemented in PLMD::DataFetchingObjectTyped< T >.

Member Data Documentation

◆ myactions

std::vector<ActionWithValue*> PLMD::DataFetchingObject::myactions
protected

Pointers to the various actions required by the grabber.

◆ myvalues

std::vector<Value*> PLMD::DataFetchingObject::myvalues
protected

The values required by the user.

◆ plumed

PlumedMain& PLMD::DataFetchingObject::plumed
protected

A copy of the plumed main object.


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