Help on some functions in Activate and Compare coupling simulation

Hi yugang,

Unfortunately there is no written help for many functions. It's on top of the todo list (but often other things get a higher priority )

vssRunSimulation is an oml function (file vssRunSimulation.oml), explanation of parameters is in this file:

function scs_m=vssRunSimulation(model,context,workspace,simobject,raiseerror,allowSimObjectCreation,reinitfunc)   
   This function is used to run the simulation of a given model.
   model: optional argument. If omitted, it is the current model.
          It can be:
            a string the filename of the model.
            a model pointer.
            an empty matrix. if the simobject is defined it is the model in the simobject, else the current model.
   context: optional argument. if omitted, it is an empty struct (default).
          It can be:
            a struct.
            an environment.
            an empty matrix, means default.
   workspace: the workspace where the simulator will read/write the signals. if omitted, the workspace is the base environment (default).
          It can be:
            an environment.
            an empty matrix, means default.
   simobject: the simulation object used by the simulation, if omitted it will be created if the allowSimObjectCreation is true (default).
          It can be:
            a simulation object pointer.
            an empty matrix, means default.
   raiseerror: Boolean, if true the function will not popup an error dialog if the simulation object is defined, else it will throw an error. default value is false.
   allowSimObjectCreation: Boolean, if true the function will create the simobject if the simobject is not defined. the default value is true.
   reinitfunc: string, the function that the compiler call after evaluation. Default value: empty string

bde-functions are internal functions, it's difficult to find a declaration.

bdeGetModelFilePath() is often used in Activate scripts, e.g.

  modelFilename = bdeGetModelFilePath(bdeGetCurrentModel());
  curmodelpath = fileparts(modelFilename);

fileparts returns the directory, name, and extension components.

Best regards

Hi yugang,

Unfortunately there is no written help for many functions. It's on top of the todo list (but often other things get a higher priority )

vssRunSimulation is an oml function (file vssRunSimulation.oml), explanation of parameters is in this file:

function scs_m=vssRunSimulation(model,context,workspace,simobject,raiseerror,allowSimObjectCreation,reinitfunc)   
   This function is used to run the simulation of a given model.
   model: optional argument. If omitted, it is the current model.
          It can be:
            a string the filename of the model.
            a model pointer.
            an empty matrix. if the simobject is defined it is the model in the simobject, else the current model.
   context: optional argument. if omitted, it is an empty struct (default).
          It can be:
            a struct.
            an environment.
            an empty matrix, means default.
   workspace: the workspace where the simulator will read/write the signals. if omitted, the workspace is the base environment (default).
          It can be:
            an environment.
            an empty matrix, means default.
   simobject: the simulation object used by the simulation, if omitted it will be created if the allowSimObjectCreation is true (default).
          It can be:
            a simulation object pointer.
            an empty matrix, means default.
   raiseerror: Boolean, if true the function will not popup an error dialog if the simulation object is defined, else it will throw an error. default value is false.
   allowSimObjectCreation: Boolean, if true the function will create the simobject if the simobject is not defined. the default value is true.
   reinitfunc: string, the function that the compiler call after evaluation. Default value: empty string

bde-functions are internal functions, it's difficult to find a declaration.

bdeGetModelFilePath() is often used in Activate scripts, e.g.

  modelFilename = bdeGetModelFilePath(bdeGetCurrentModel());
  curmodelpath = fileparts(modelFilename);

fileparts returns the directory, name, and extension components.

Best regards

 

 

Hello,

Ah, it could be a problem. Because sometimes we might don't know this function exists ...

For example, we can use VssRunSimulation(), to call activate for simulation model.

This function is told to me by my French colleague.

If he did not tell me, I might not ever to discover this function. Since no way to find it ... as it not exist.

Hello,

Ah, it could be a problem. Because sometimes we might don't know this function exists ...

For example, we can use VssRunSimulation(), to call activate for simulation model.

This function is told to me by my French colleague.

If he did not tell me, I might not ever to discover this function. Since no way to find it ... as it not exist.

 

Yes, same with me. And there are so many functions ...

It's always a help for me to look at scripts in demo models, tutorials, and other stuff to get an idea of some (unknown) functions.