Subroutine Type

Utility/Data access.

Definition

A subroutine called by MotionSolve to generate messages.

Use

Generation of a customized message file containing solver messages.

<MESSAGING>

   LOG_OPTION          = { "Overwrite" | "ScreenOnly" | "Append" }  

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

   USRSUB_DLL_NAME     = valid_path_name

   USRSUB_FNC_NAME     = "MESSAGE_SUB"

</MESSAGING>

Calling Syntax

Fortran

SUBROUTINE MESSAGE_SUB (MSG_ID, TIME, PAR, NPAR, MSGTYPE, IFLAG, ENDFLAG, ERRFLG, MESSAGE, OUTNAME)

C

void STDCALL MESSAGE_SUB (int *msgid, double *time, double *par, int *npar, int *msgtype,int *iflag, int *endflag, int *errflg, char *message, int len_message, char *outname, int len_outname)

Python

Not Supported

MATLAB

Not supported

Input Arguments

[integer] MSG_ID

The message ID.

[double precision] TIME

The current simulation time.

[double precision] PAR

An array that contains the constant arguments from the list provided in the
user-defined statement.

[integer] NPAR

The number of entries in the PAR array.

[integer] MSGTYPE

[int] IFLAG

The initialization flag.

[int] ENDFLAG

[int] ERRFLAG

The initialization flag.

[string] MESSAGE

A character array containing the message.

[string] OUTNAME

Output Values

None.

Example

A working example may be found in the folder
[install_path]\hwsolvers\motionsolve\usersub\.