OrsSessionManager

Manages creating and saving sessions

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4
copyright:Object Research Systems (ORS), Inc. All rights reserved 2020.
date:Oct 26 2015 08:12
dragonflyVersion:
 3.1.0.286 (D)
UUID:334d0352761a11e7a9cd448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsSessionManager.OrsSessionManager.OrsSessionManager(varName=None, managed=True)
closable = False
classmethod getSessionDataObjects()
classmethod getSessionHasData()

Checks to see if session current has data (thus does it require a New Session?) :return: True if live data exists, False otherwise. :rtype: bool

classmethod import_only_from_file(filename='', legacy=False)
keepAlive = False
classmethod loadSession()
classmethod loadSessionAction()
interfacemethod loadSessionFromFile(fileName)

Load a session from file

Parameters:fileName (file) –
classmethod loadSessionInteractive(fname=None, disablePopup=False)
multiple = False
classmethod newSession()
classmethod newSessionAction()
classmethod recentFilesForSessionsTemp()
savable = True
classmethod saveSession()
classmethod saveSessionAction()
classmethod saveSessionActionAs()
classmethod saveSessionAs()
classmethod saveSessionInteractive(askUserForFile=True)

Starts the process of saving a session, and interacts with the user

Parameters:askUserForFile (bool) – True to ask the user where to save (Save As), False to just save to current file (will act as Save As if no current file).
interfacemethod saveSessionToFile(fileName, progress)

Save session in file

Parameters:
Returns:

output (int) – success
classmethod startNewSessionInteractive()

Starts a new session, but if no objects live in the current session then just bypass

Returns:output – None