umetrics
index
(built-in)

 
Package Contents
       

 
Classes
       
Boost.Python.instance(builtins.object)
SimcaApp
builtins.Exception(builtins.BaseException)
SIMCAException

 
class SIMCAException(builtins.Exception)
    
Method resolution order:
SIMCAException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class SimcaApp(Boost.Python.instance)
    The SIMCA application object.
 
 
Method resolution order:
SimcaApp
Boost.Python.instance
builtins.object

Methods defined here:
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods defined here:
cascade_windows(...)
cascade_windows() -> None :
    Arranges all the child windows in a cascade format.
general_options(...)
general_options() -> GeneralOptions :
    Returns the SIMCA general options object
get_active_project(...)
get_active_project() -> Project :
    Returns the currently active project.
    If there is no active project, the method returns a closed project.
    Although SIMCA can handle many simultaneously open projects, only one can be active.
    The active project is the one that the user 'sees' and can manipulate through the GUI
    .Recommended usage is:
    with SimcaApp.getactiveproject() as project:
        if project:
            # Do something with project
get_active_window_title(...)
get_active_window_title() -> str :
    Returns the title of the active window
get_version(...)
get_version() -> tuple :
    Returns a tupple containing the major and minor version of SIMCA.
is_active_project(...)
is_active_project( (Project)project) -> bool :
    Returns True if the project is the active project (the one that the user 'sees'
    and can manipulate through the GUI).
plot_list_builder(...)
plot_list_builder() -> PlotListBuilder :
    Returns the SIMCA plot builder object
set_active_project(...)
set_active_project( (Project)project) -> None :
    Sets the active project.
    The previously active project (if any) will be closed.
    The project must have at least one dataset.
set_verbosity(...)
set_verbosity( (bool)verbosity) -> None :
    Turns printing of information messages to stdout on or off. Default is True (on).
tile_windows(...)
tile_windows() -> None :
    Arranges all child windows in a tiled format.

Data and other attributes defined here:
GeneralOptions = <class 'umetrics.GeneralOptions'>
SIMCA general options class.
PlotListBuilder = <class 'umetrics.PlotListBuilder'>
SIMCA plot and list builder object.

Methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
Functions
       
cexit(...)
cexit() -> None :
    Exit SIMCA