MESSAGE_SUB

Utility/Data Access SubroutineA 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>

Format

Fortran Calling Syntax
SUBROUTINE MESSAGE_SUB (MSG_ID, TIME, PAR, NPAR, MSGTYPE, IFLAG, ENDFLAG, ERRFLG, MESSAGE, OUTNAME)
C/C++ Calling Syntax
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 Calling Syntax
def MESSAGE_SUB (msgid, time, par, npar, msgtype, iflag, endflag, message, outname):
   return errflg
MATLAB Calling Syntax
Not supported.

Attributes

MSG_ID
[integer]
The message ID.
TIME
[double precision]
The current simulation time.
PAR
[double precision]
An array that contains the constant arguments from the list provided in the user-defined statement.
NPAR
[integer]
The number of entries in the PAR array.
MSGTYPE
[integer]
IFLAG
[integer]
The initialization flag.
ENDFLAG
[integer]
ERRFLAG
[integer]
The initialization flag.
MESSAGE
[string]
A character array containing the message.
OUTNAME
[string]

Example

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