STIR 6.5.0
stir::KineticModel Class Referenceabstract

base class for all kinetic models More...

#include "stir/modelling/KineticModel.h"

Inheritance diagram for stir::KineticModel:

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.
Public Member Functions inherited from stir::ParsingObject
 ParsingObject (const ParsingObject &)
ParsingObject & operator= (const ParsingObject &)
bool parse (std::istream &f)
bool parse (const char *const filename)
void ask_parameters ()
virtual std::string parameter_info ()

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 KineticModel * read_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.
static KineticModel * ask_type_and_parameters ()
 ask the user for the type, and then calls read_registered_object(0, type)
static void list_registered_names (std::ostream &stream)
 List all possible registered names to the stream.
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_less > RegistryType
 The type of the registry.
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.
virtual void set_key_values ()
 This will be called before parsing or parameter_info is called.
Static Protected Member Functions inherited from stir::RegisteredObject< KineticModel >
static RegistryType & registry ()
 Static function returning the registry.
KeyParser parser

Detailed Description

base class for all kinetic models

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

Constructor & Destructor Documentation

◆ KineticModel()

stir::KineticModel::KineticModel ( )

default constructor

References KineticModel().

Referenced by KineticModel().

◆ ~KineticModel()

stir::KineticModel::~KineticModel ( )
override

default destructor

References ~KineticModel().

Referenced by ~KineticModel().


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