Modeling Element

Description

The Post_UserAPI element allows you to generate your own results file.

Format

<Post_UserAPI>

    USRSUB_PARAM_STRING = "USER( [[par_1 [, ...][,par_n]] )"

    USRSUB_DLL_NAME     = valid_path_name

    USRSUB_FNC_NAME     = custom_fnc_name >

|

    SCRIPT_NAME         = valid_path_name

    INTERPRETER         = "PYTHON" | "MATLAB"

    USRSUB_PARAM_STRING = "USER( [[par_1 [, ...][,par_n]] )"

    USRSUB_FNC_NAME     = "custom_fnc_name" >

</Post_UserAPI>

Attributes

usrsub_param_string

The list of parameters that are passed from the data file to the user written subroutine message_sub.

usrsub_dll_name

Specifies the path and name of the DLL or shared library containing user subroutine.  MotionSolve uses this information to load the user subroutine in the DLL at run time.

usrsub_fnc_name

Specifies an alternative name for the user subroutine POST_SUB.

script_name

Specifies the path and name of the user written script that contains the routine specified by usrsub_fnc_name.

interpreter

Specifies the interpreted language that the user script is written in. Valid choices are MATLAB or PYTHON.

Model Element

Description

The UPOST element allows you to generate your own results file.

Declaration

def UPOST(FUNCTION="", ROUTINE="", INTERPRETER="", SCRIPT=""):

Attributes

FUNCTION

The list of parameters that are passed from the data file to the user defined subroutine.  This attribute is common to all types of user subroutines and scripts.

ROUTINE
 

Specifies an alternative name for the user subroutine POST_SUB.

INTERPRETER

Specifies the interpreted language that the user script is written in. Valid choices are MATLAB or PYTHON.

SCRIPT

Specifies the path and name of the user written script that contains the routine.

Comments

See Post_UserAPI

Example

The below example below demonstrates the specification of the UPOST element.

UPOST(FUNCTION="USER()",ROUTINE="POST_SUB",INTERPRETER="Python",SCRIPT="post_sub.py")