Module ctsimu.scenario.stage

A CTSimU sample stage: position, orientation.

Expand source code 
# -*- coding: UTF-8 -*-
"""
A CTSimU sample stage: position, orientation.
"""

from ..helpers import *
from ..geometry import *
from .part import Part
from .parameter import Parameter
from .group import Group, Array

class Stage(Part):
        """CTSimU sample stage."""
        def __init__(self, _root=None):
                Part.__init__(self, name="stage", _root=_root)

        def set_from_json(self, json_scenario:dict):
                """Import the stage definition and geometry from the JSON object.
                The JSON object should contain the complete content
                of the scenario definition file
                (at least the geometry section).

                Parameters
                ----------
                json_scenario : dict
                        A complete CTSimU scenario object, as imported from a JSON structure.
                """
                self.reset()

                # Extract the stage's geometry:
                geo = json_extract(json_scenario, ["geometry", "stage"])
                self.set_geometry(json_geometry_object=geo, proper_cs="local")

Classes

class Stage

CTSimU sample stage.

The part's name can be set upon initialization.

Parameters

name : str
Name for the part.
Expand source code 
class Stage(Part):
        """CTSimU sample stage."""
        def __init__(self, _root=None):
                Part.__init__(self, name="stage", _root=_root)

        def set_from_json(self, json_scenario:dict):
                """Import the stage definition and geometry from the JSON object.
                The JSON object should contain the complete content
                of the scenario definition file
                (at least the geometry section).

                Parameters
                ----------
                json_scenario : dict
                        A complete CTSimU scenario object, as imported from a JSON structure.
                """
                self.reset()

                # Extract the stage's geometry:
                geo = json_extract(json_scenario, ["geometry", "stage"])
                self.set_geometry(json_geometry_object=geo, proper_cs="local")

Ancestors

Methods

def set_from_json(self, json_scenario: dict)

Import the stage definition and geometry from the JSON object. The JSON object should contain the complete content of the scenario definition file (at least the geometry section).

Parameters

json_scenario : dict
A complete CTSimU scenario object, as imported from a JSON structure.
Expand source code 
def set_from_json(self, json_scenario:dict):
        """Import the stage definition and geometry from the JSON object.
        The JSON object should contain the complete content
        of the scenario definition file
        (at least the geometry section).

        Parameters
        ----------
        json_scenario : dict
                A complete CTSimU scenario object, as imported from a JSON structure.
        """
        self.reset()

        # Extract the stage's geometry:
        geo = json_extract(json_scenario, ["geometry", "stage"])
        self.set_geometry(json_geometry_object=geo, proper_cs="local")

Inherited members