SIMZ/SIM_SolverScript.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc.
 *      477 Richmond Street West, Suite 1001
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 */

#ifndef __SIM_SolverScript_h__
#define __SIM_SolverScript_h__

#include "SIMZ_API.h"
#include <SIM/SIM_OptionsUser.h>
#include <SIM/SIM_Solver.h>
#include "SIMZ_Utils.h"

class SIM_GeometryCopy;
class SIM_SolverScript;

class SIMZ_API SIM_SolverScriptData
{
public:
                         SIM_SolverScriptData()
                             : mySolver(0),
                               myObjects(0),
                               myTimestep(0),
                               myIsInitializing(false)
                         { }
                         SIM_SolverScriptData(SIM_SolverScript *solver,
                                              const SIM_ObjectArray *objects,
                                              const SIM_Time *timestep,
                                              bool is_initializing)
                             : mySolver(solver),
                               myObjects(objects),
                               myTimestep(timestep),
                               myIsInitializing(is_initializing)
                         { }
                        ~SIM_SolverScriptData()
                         { }

    static UT_RefArray<SIM_SolverScriptData> &getSolverStack();

    SIM_SolverScript            *mySolver;
    const SIM_ObjectArray       *myObjects;
    const SIM_Time              *myTimestep;
    bool                         myIsInitializing;
};

class SIMZ_API SIM_SolverScript : public SIM_Solver,
                                  public SIM_OptionsUser
{
public:
    // Access functions for our specific data.
    GETSET_DATA_FUNCS_S(SIM_NAME_SCRIPT, Script);
    GETSET_DATA_FUNCS_S(SIM_NAME_INITSCRIPT, InitScript);

    void                 getDopnetPath(UT_String &path) const;
    const SIM_Engine    &getDopnetEngine() const;
    static void          installCommands();

protected:
    explicit             SIM_SolverScript(const SIM_DataFactory *factory);
    virtual             ~SIM_SolverScript();

    virtual SIM_Result   solveObjectsSubclass(SIM_Engine &engine,
                                        SIM_ObjectArray &objects,
                                        SIM_ObjectArray &newobjects,
                                        SIM_ObjectArray &feedbacktoobjects,
                                        const SIM_Time &timestep);

private:
    SIM_Result           runScript(
                            const char *script,
                            const char *description,
                            const SIM_ObjectArray &objects,
                            const SIM_Time &timestep,
                            bool is_initializing);
    SIM_Result           runHscriptScript(
                            const char *script,
                            const char *description);
    SIM_Result           runPythonScriptFile(
                            const char *script_file,
                            const char *description);

    static const SIM_DopDescription     *getSolverScriptDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_SolverScript,
                        SIM_Solver,
                        "Script Solver",
                        getSolverScriptDopDescription());
};

#endif

---