AuxiliarySystemInputSetup

Qualified name: loads.auxiliary_system_input.api.auxiliary_system_input_api.AuxiliarySystemInputSetup

class loads.auxiliary_system_input.api.auxiliary_system_input_api.AuxiliarySystemInputSetup(item)

Bases: LoadSetup

The API handler for auxiliary system inputs

The following example shows how to create an auxiliary system input using the API, it is assumed that these steps were performed in each of the examples for other methods in this class.

Example

>>> from more.api import ApiGateway
>>> api = ApiGateway(proj=proj)
>>> simulation_setup = api.create_simulation_setup()
>>> lcc_setup = simulation_setup.create_load_case_container_setup().set_name(name='Example LCC')
>>> lc_setup = lcc_setup.create_load_case_setup(lc_type='Mechanical load case').set_name(name='Example LC')
>>> auxiliary_system_input_setup = lc_setup.create_load_setup(load_type='Control module input')

The next example shows how to get an API object for an already existing load.

Example

>>> from more.api import ApiGateway
>>> api = ApiGateway(proj=proj)
>>> simulation_setup = api.create_simulation_setup()
>>> lcc_setup = simulation_setup.create_load_case_container_setup().set_name(name='Example LCC')
>>> lc_setup = lcc_setup.create_load_case_setup(lc_type='Mechanical load case').set_name(name='Example LC')

>>> auxiliary_system_input_setup = lc_setup.get_load_setup(index=0) # The load under this index must already exist

Methods

set_auxiliary_system_by_name	Sets the auxiliary system for the associated auxiliary system input
set_auxiliary_system_input_by_name	Sets the external input for the associated auxiliary system input
set_command_value	Deprecated method
set_command_value_by_name	Deprecated method
set_controller	Deprecated method
set_controller_by_name	Deprecated method

Attributes

available_auxiliary_system_input_names	Returns the list of available external input names
available_command_value_names	Deprecated method
available_command_values_dict	Deprecated method

property available_auxiliary_system_input_names: List[str]

Returns the list of available external input names

See example at the top for how to create an auxiliary system input setup object

Example

>>> auxiliary_system_input_setup.available_auxiliary_system_input_names
['Position command value', 'Velocity command value', 'Position command value with setpoint scaling']

Returns:

The list of available command values

Return type:

list of strings

property available_command_value_names: List[str]

Deprecated method

Deprecated

available_command_value_names will be removed in a future MORe release, it is replaced by available_auxiliary_system_input_names()

property available_command_values_dict

Deprecated method

Deprecated

available_command_values_dict will be removed in a future MORe release, it is replaced by available_command_value_names()

set_auxiliary_system_by_name(auxiliary_system_name: str) → AuxiliarySystemInputSetup

Sets the auxiliary system for the associated auxiliary system input

See example at the top for how to create an auxiliary system input setup object

Example

>>> auxiliary_system_input_setup = auxiliary_system_input_setup.set_auxiliary_system_by_name(auxiliary_system_name='example auxiliary_system') # The controller with this name must already exist

Returns:

self

Return type:

AuxiliarySystemInputSetup

Raises:

NameNotFoundError – Raised if a key in the name is not a viable controller

set_auxiliary_system_input_by_name(input_name) → AuxiliarySystemInputSetup

Sets the external input for the associated auxiliary system input

See example at the top for how to create an auxiliary system input setup object

Example

>>> auxiliary_system_input_setup = auxiliary_system_input_setup.set_auxiliary_system_by_name(auxiliary_system_name='example auxiliary_system') # The controller with this name must already exist
>>> auxiliary_system_input_setup = auxiliary_system_input_setup.set_auxiliary_system_input_by_name(input_name='Position command value')

Returns:

self

Return type:

AuxiliarySystemInputSetup

Raises:

NameNotFoundError – Raised if a key in there is no external input with the given name

set_command_value(command_value)

Deprecated method

Deprecated

set_command_value will be removed in a future MORe release, it is replaced by set_command_value_by_name()

set_command_value_by_name(command_value_name: str) → AuxiliarySystemInputSetup

Deprecated method

Deprecated

set_command_value_by_name will be removed in a future MORe release, it is replaced by set_auxiliary_system_input_by_name()

set_controller(controller)

Deprecated method

Deprecated

set_controller will be removed in a future MORe release, it is replaced by set_controller_by_name()

set_controller_by_name(controller_name: str) → AuxiliarySystemInputSetup

Deprecated method

Deprecated

set_controller_by_name will be removed in a future MORe release, it is replaced by set_auxiliary_system_by_name()