MaterialXConversionApp.MaterialXFlaskApp Class Reference

Inheritance diagram for MaterialXConversionApp.MaterialXFlaskApp:

Public Member Functions
	__init__ (self, home)
	run (self, host, port, deployment_platform, debug=True)
	Run the Flask server with SocketIO.

Public Attributes
	home = home
	app = Flask(__name__)
	socketio = SocketIO(self.app)
str	deployment_platform = 'Local'
	os_details = get_os_details()

Protected Member Functions
	_register_routes (self)
	Register HTTP routes.
	_setup_event_handler_map (self)
	Pure virtual method: Must be implemented by subclasses.
	_register_socket_events (self)
	Register SocketIO events.

Detailed Description

Definition at line 37 of file MaterialXConversionApp.py.

Constructor & Destructor Documentation

__init__()

MaterialXConversionApp.MaterialXFlaskApp.__init__	(		self,
			home )

Reimplemented in MaterialXConversionApp.MaterialXConversionApp.

Definition at line 38 of file MaterialXConversionApp.py.

    def __init__(self, home):
        self.home = home
 
        # Initialize Flask and SocketIO
        self.app = Flask(__name__)
        self.socketio = SocketIO(self.app)
 
        # Register routes and events
        self._register_routes()
        self._setup_event_handler_map()
        self._register_socket_events()
 
        self.deployment_platform = 'Local'
        print(f'* Initialized on deployment plaform: {self.deployment_platform}')
        self.os_details = get_os_details()
        print(f"  * OS: {self.os_details['os']}")
        print(f"  * Release: {self.os_details['release']}")
        print(f"  * Architecture: {self.os_details['architecture']}")
 

Member Function Documentation

_register_routes()

MaterialXConversionApp.MaterialXFlaskApp._register_routes ( self )

protected

Register HTTP routes.

Definition at line 57 of file MaterialXConversionApp.py.

    def _register_routes(self):
        '''
        Register HTTP routes.
        '''
        @self.app.route('/')
        def home():
            '''
            Render the home page.
            '''
            #status_message = f'Startup: Using MaterialX version: {mx.getVersionString()}'
            #self._emit_status_message(status_message)
            return render_template(self.home)
 

_register_socket_events()

MaterialXConversionApp.MaterialXFlaskApp._register_socket_events ( self )

protected

Register SocketIO events.

Definition at line 74 of file MaterialXConversionApp.py.

    def _register_socket_events(self):
        '''
        Register SocketIO events.
        '''
        # Dynamically register event handlers
        for event_name, handler in self.event_handlers.items():
            self.socketio.on_event(event_name, handler)        
 

_setup_event_handler_map()

MaterialXConversionApp.MaterialXFlaskApp._setup_event_handler_map ( self )

protected

Pure virtual method: Must be implemented by subclasses.

Reimplemented in MaterialXConversionApp.MaterialXConversionApp.

Definition at line 70 of file MaterialXConversionApp.py.

    def _setup_event_handler_map(self):
        '''Pure virtual method: Must be implemented by subclasses.'''
        raise NotImplementedError("Subclasses must implement _setup_event_handler_map")
 

run()

MaterialXConversionApp.MaterialXFlaskApp.run	(		self,
			host,
			port,
			deployment_platform,
			debug = True )

Run the Flask server with SocketIO.

Definition at line 82 of file MaterialXConversionApp.py.

    def run(self, host, port, deployment_platform, debug=True):
        '''
        Run the Flask server with SocketIO.
        '''
        self.deployment_platform = deployment_platform
        self.socketio.run(self.app, host, port, debug=debug)
 

Member Data Documentation

app

MaterialXConversionApp.MaterialXFlaskApp.app = Flask(__name__)

Definition at line 42 of file MaterialXConversionApp.py.

deployment_platform

str MaterialXConversionApp.MaterialXFlaskApp.deployment_platform = 'Local'

Definition at line 50 of file MaterialXConversionApp.py.

home

MaterialXConversionApp.MaterialXFlaskApp.home = home

Definition at line 39 of file MaterialXConversionApp.py.

os_details

MaterialXConversionApp.MaterialXFlaskApp.os_details = get_os_details()

Definition at line 52 of file MaterialXConversionApp.py.

socketio

MaterialXConversionApp.MaterialXFlaskApp.socketio = SocketIO(self.app)

Definition at line 43 of file MaterialXConversionApp.py.

---

The documentation for this class was generated from the following file:

• MaterialXConversionApp.py