globals - janklab.mlxshake
janklab.mlxshake.globals
Helptext
Global library properties and settings for MlxShake.
Note that if you want to change the settings, you can’t do this:
janklab.mlxshake.globals.settings.someSetting = 42;
That will break due to how Matlab Constant properties work. Instead, you need to first grab the Settings object and store it in a variable, and then work on that:
s = janklab.mlxshake.globals.settings;
s.someSetting = 42;
Class Contents
Properties
| Property | Description |
|---|---|
| distroot | |
| settings |
Methods
| Method | Description |
|---|---|
| loglevel | |
| initialize | |
| version | |
| globals | Constructor. |
Properties
distroot
Attributes: Constant, NonCopyable, HasDefault
Default Value: "/Users/janke/local/repos/MlxShake"
Helptext:
No helptext available.
settings
Attributes: Constant, NonCopyable, HasDefault
Default Value:
Helptext:
No helptext available.
Methods
loglevel
Attributes: Static
Signature:
out = globals.loglevel(newLevel)
Helptext:
Get or set logging level for the mlxshake package.
out = janklab.mlxshake.globals.loglevel()
oldLevel = janklab.mlxshake.globals.loglevel(newLevel)
This is a convenience method that provides a simplified interface on top of MlxShake’s internal logging tools. It does not support all functionality of level control. This is intentional, to keep the interface simple.
NewLevel (string) is the logging level to set at the root janklab.mlxshake package. This should control all logging done by MlxShake. Valid values are:
- “info” - The regular, concise and quiet logging.
- “debug” - More detailed logging, with progress messages.
The return value is the currently-set logging level. Possible values are:
- “info”
- “debug”
- “custom” - Means the logging configuration is in a weird state that this function is not prepared to handle.
initialize
Attributes: Static
Signature:
globals.initialize()
Helptext:
Initialize this library/package.
version
Attributes: Static
Signature:
out = globals.version()
Helptext:
The version of the MlxShake library.
Returns a string.
globals
Signature:
obj = globals()
Helptext:
Global library properties and settings for MlxShake.
Note that if you want to change the settings, you can’t do this:
janklab.mlxshake.globals.settings.someSetting = 42;
That will break due to how Matlab Constant properties work. Instead, you need to first grab the Settings object and store it in a variable, and then work on that:
s = janklab.mlxshake.globals.settings;
s.someSetting = 42;