Sofa.Helper
General description
Tooling to print messages or create vectors of different type.
Sofa provides a fully feature messaging system allowing to emit messages. The way the message are printed depends on the application. Messages can be routed the console, log files, GUI or ignored.
There are several kind of messages.
The ‘info’ messages are emitted only when the object.printLog is set to True. The ‘warning’ messages are emitted when the object want the user to be informed. The ‘error’ messages are emitted when the object cannot perform as expected. The ‘deprecated’ messages are indicating that some feature are now deprecated and thus be fixed as soon as possible. In general we provide updates tips with deprecated messages.
Examples of use
msg_error("something bad happens") msg_error(sofaObject, "something bad happens") msg_warning(sofaNode, "something happens that sofaNode must be award of") msg_warning(emitting_file, emitting_loc, "something bad happens at given location") msg_info(sofaObject, "something happens", emitting_file, emitting_loc) msg_info(sofaNode, "something happens", emitting_file, emitting_loc)
API Table of Content
Functions
Emit a deprecated message from python.
Emit an error message from python.
Emit a fatal error message from python.
Emit an info message from python.
Emit a warning message from python.
Classes
Overloaded function.
Overloaded function.
Overloaded function.
Overloaded function.
Overloaded function.
Overloaded function.
Overloaded function.