STIR  6.2.0
Public Member Functions | Static Public Attributes | List of all members
stir::KineticModel Class Referenceabstract

base class for all kinetic modelsAt present very basic. It just provides the parsing mechanism. More...

#include "stir/modelling/KineticModel.h"

Inheritance diagram for stir::KineticModel:
Inheritance graph
[legend]

Public Member Functions

 KineticModel ()
 default constructor
 
 ~KineticModel () override
 default destructor
 
virtual Succeeded set_up ()=0
 
- Public Member Functions inherited from stir::RegisteredObjectBase
virtual std::string get_registered_name () const =0
 Returns the name of the type of the object. More...
 
- Public Member Functions inherited from stir::ParsingObject
 ParsingObject (const ParsingObject &)
 
ParsingObjectoperator= (const ParsingObject &)
 
void ask_parameters ()
 
virtual std::string parameter_info ()
 
bool parse (std::istream &f)
 
bool parse (const char *const filename)
 

Static Public Attributes

static const char *const registered_name = "Kinetic Model Type"
 

Additional Inherited Members

- Static Public Member Functions inherited from stir::RegisteredObject< KineticModel >
static KineticModelread_registered_object (std::istream *in, const std::string &registered_name)
 Construct a new object (of a type derived from Root, its actual type determined by the registered_name parameter) by parsing the istream. More...
 
static KineticModelask_type_and_parameters ()
 ask the user for the type, and then calls read_registered_object(0, type) More...
 
static void list_registered_names (std::ostream &stream)
 List all possible registered names to the stream. More...
 
- Protected Types inherited from stir::RegisteredObject< KineticModel >
typedef KineticModel *(* RootFactory) (std::istream *)
 The type of a root factory is a function, taking an istream* as argument, and returning a Root*.
 
typedef FactoryRegistry< std::string, RootFactory, interfile_lessRegistryType
 The type of the registry.
 
- Protected Member Functions inherited from stir::ParsingObject
virtual void set_defaults ()
 Set defaults before parsing.
 
virtual void initialise_keymap ()
 Initialise all keywords.
 
virtual bool post_processing ()
 This will be called at the end of the parsing. More...
 
virtual void set_key_values ()
 This will be called before parsing or parameter_info is called. More...
 
- Static Protected Member Functions inherited from stir::RegisteredObject< KineticModel >
static RegistryTyperegistry ()
 Static function returning the registry. More...
 
- Protected Attributes inherited from stir::ParsingObject
KeyParser parser
 

Detailed Description

base class for all kinetic models

At present very basic. It just provides the parsing mechanism.


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