MOOSE - Multiscale Object Oriented Simulation Environment
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
ReadOnlyValueFinfo< T, F > Class Template Reference

#include <ValueFinfo.h>

+ Inheritance diagram for ReadOnlyValueFinfo< T, F >:
+ Collaboration diagram for ReadOnlyValueFinfo< T, F >:

Public Member Functions

 ReadOnlyValueFinfo (const string &name, const string &doc, F(T::*getFunc)() const )
 
void registerFinfo (Cinfo *c)
 
string rttiType () const
 
bool strGet (const Eref &tgt, const string &field, string &returnValue) const
 
bool strSet (const Eref &tgt, const string &field, const string &arg) const
 
 ~ReadOnlyValueFinfo ()
 
- Public Member Functions inherited from ValueFinfoBase
DestFinfogetFinfo () const
 
vector< string > innerDest () const
 
 ValueFinfoBase (const string &name, const string &doc)
 
 ~ValueFinfoBase ()
 
- Public Member Functions inherited from Finfo
virtual bool addMsg (const Finfo *target, ObjId mid, Element *src) const
 
virtual bool checkTarget (const Finfo *target) const
 
const string & docs () const
 Returns documentation string. More...
 
 Finfo (const string &name, const string &doc)
 
virtual vector< string > innerSrc () const
 
const string & name () const
 
virtual void postCreationFunc (Id newId, Element *newElm) const
 
virtual ~Finfo ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Finfo
static const CinfoinitCinfo ()
 
- Protected Attributes inherited from ValueFinfoBase
DestFinfoget_
 
DestFinfoset_
 

Detailed Description

template<class T, class F>
class ReadOnlyValueFinfo< T, F >

Definition at line 87 of file ValueFinfo.h.

Constructor & Destructor Documentation

template<class T, class F>
ReadOnlyValueFinfo< T, F >::~ReadOnlyValueFinfo ( )
inline

Definition at line 90 of file ValueFinfo.h.

References ValueFinfoBase::get_.

90  {
91  delete get_;
92  }
DestFinfo * get_
Definition: ValueFinfo.h:33
template<class T, class F>
ReadOnlyValueFinfo< T, F >::ReadOnlyValueFinfo ( const string &  name,
const string &  doc,
F(T::*)() const  getFunc 
)
inline

Definition at line 94 of file ValueFinfo.h.

References ValueFinfoBase::get_, and Finfo::name().

96  : ValueFinfoBase( name, doc )
97  {
98  string getname = "get" + name;
99  getname[3] = std::toupper( getname[3] );
100  get_ = new DestFinfo(
101  getname,
102  "Requests field value. The requesting Element must "
103  "provide a handler for the returned value.",
104  new GetOpFunc< T, F >( getFunc ) );
105  }
DestFinfo * get_
Definition: ValueFinfo.h:33
ValueFinfoBase(const string &name, const string &doc)
Definition: ValueFinfo.cpp:12
const string & name() const
Definition: Finfo.cpp:80

+ Here is the call graph for this function:

Member Function Documentation

template<class T, class F>
void ReadOnlyValueFinfo< T, F >::registerFinfo ( Cinfo c)
inlinevirtual

Returns string-ified form to handle template expectations for name field string getName() const; Assign function Ids, bindIndex and so on.

Implements Finfo.

Definition at line 108 of file ValueFinfo.h.

References ValueFinfoBase::get_, and Cinfo::registerFinfo().

108  {
109  c->registerFinfo( get_ );
110  }
DestFinfo * get_
Definition: ValueFinfo.h:33
void registerFinfo(Finfo *f)
Definition: Cinfo.cpp:114

+ Here is the call graph for this function:

template<class T, class F>
string ReadOnlyValueFinfo< T, F >::rttiType ( ) const
inlinevirtual

Returns the documentation string for the Finfo string docs() const; Returns the RTTI type string for the finfo by referring to an internal virtual function. string type() const; Returns the list of subsidiary SrcFinfos. Used in Shared Finfos, empty otherwise. Goes via internal virtual function. vector< string > src() const; Returns the list of subsidiary destFinfos. Used in SharedFinfos and ValueFinfos, empty otherwise. Goes via internal virtual function. vector< string > dest() const; Returns an RTTI type string for this Finfo.

Reimplemented from Finfo.

Definition at line 123 of file ValueFinfo.h.

References Conv< T >::rttiType().

123  {
124  return Conv<F>::rttiType();
125  }
static string rttiType()
Definition: Conv.h:82

+ Here is the call graph for this function:

template<class T, class F>
bool ReadOnlyValueFinfo< T, F >::strGet ( const Eref tgt,
const string &  field,
string &  returnValue 
) const
inlinevirtual

Function to return value of field into a string argument. Returns true on success. Normally called only from SetGet::strGet.

Implements Finfo.

Definition at line 117 of file ValueFinfo.h.

References Field< A >::innerStrGet(), and Eref::objId().

118  {
120  tgt.objId(), field, returnValue );
121  }
static bool innerStrGet(const ObjId &dest, const string &field, string &str)
Definition: SetGet.h:345
ObjId objId() const
Definition: Eref.cpp:57

+ Here is the call graph for this function:

template<class T, class F>
bool ReadOnlyValueFinfo< T, F >::strSet ( const Eref tgt,
const string &  field,
const string &  arg 
) const
inlinevirtual

Function to set this field using a string argument. Returns true on success. Normally called only from SetGet::strSet.

Implements Finfo.

Definition at line 112 of file ValueFinfo.h.

113  {
114  return 0;
115  }

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