egs_ausgab_object.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ ausgab object headers
#  Copyright (C) 2015 National Research Council Canada
#
#  This file is part of EGSnrc.
#
#  EGSnrc is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the
#  Free Software Foundation, either version 3 of the License, or (at your
#  option) any later version.
#
#  EGSnrc is distributed in the hope that it will be useful, but WITHOUT ANY
#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
#  FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
#  more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with EGSnrc. If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################
#
#  Author:          Iwan Kawrakow, 2009
#
#  Contributors:    Reid Townson
#
###############################################################################
*/
 
 
#ifndef EGS_AUSGAB_OBJECT_
#define EGS_AUSGAB_OBJECT_
 
#include "egs_application.h"
#include "egs_object_factory.h"
#include "egs_input_struct.h"
 
#include <string>
#include <iostream>
using namespace std;
 
class EGS_Input;
class EGS_Application;
 
static shared_ptr<EGS_BlockInput> ausBlockInput = make_shared<EGS_BlockInput>("ausgab object");
inline void setBaseAusgabObjectInputs() {
    ausBlockInput->addSingleInput("library", true, "The type of ausgab object, loaded by shared library in egs++/dso.");
    ausBlockInput->addSingleInput("name", true, "The user-declared unique name of this ausgab object. This is the name you may refer to elsewhere in the input file.");
}
 
class EGS_EXPORT EGS_AusgabObject : public EGS_Object {
 
public:
 
    EGS_AusgabObject(const string &Name="", EGS_ObjectFactory *f = 0) : EGS_Object(Name,f), app(0) {};
 
    EGS_AusgabObject(EGS_Input *input, EGS_ObjectFactory *f = 0) : EGS_Object(input,f), app(0) {};
 
    virtual ~EGS_AusgabObject() {};
 
    virtual int processEvent(EGS_Application::AusgabCall iarg) = 0;
    virtual int processEvent(EGS_Application::AusgabCall iarg, int ir) {
        (void)iarg; // Explicitly silence the "unused parameter" compiler warning
        (void)ir;
        return 0;
    };
 
    virtual bool needsCall(EGS_Application::AusgabCall iarg) const {
        (void)iarg;
        return false;
    };
 
    virtual void setApplication(EGS_Application *App) {
        app = App;
    };
 
    virtual void setCurrentCase(EGS_I64 ncase) {
        (void)ncase;
    };
 
    const char *getObjectDescription() const {
        return description.c_str();
    };
 
    virtual bool storeState(ostream &data_out) const {
        (void)data_out;
        return true;
    };
 
    virtual bool setState(istream &data_in) {
        (void)data_in;
        return true;
    };
 
    virtual bool addState(istream &data_in) {
        (void)data_in;
        return true;
    };
 
    virtual void resetCounter() {};
 
    virtual void reportResults() {};
 
    static void createAusgabObjects(EGS_Input *);
 
    static EGS_AusgabObject *getAusgabObject(const string &Name);
 
    static void addKnownAusgabObject(EGS_AusgabObject *o);
 
    static void addKnownTypeId(const char *name);
 
    static int nObjects();
 
    static EGS_AusgabObject *getObject(size_t j);
 
protected:
 
    string description;
 
    EGS_Application *app;
 
};
 
#endif