Model: model component handles

ModelComponentHandle

Persisted typed handle to a model component.

Handles are snapshot views backed by model-head reads/writes. Mutators commit immediately through the parent model edit endpoint, then refresh local state.

Returned by: ModelComponentHandle.add_link, ModelComponentHandle.add_tag, ModelComponentHandle.clear_links, ModelComponentHandle.clone, ModelComponentHandle.refresh, ModelComponentHandle.remove_link, ModelComponentHandle.remove_tag, ModelComponentHandle.set_description, ModelComponentHandle.set_display_name, ModelComponentHandle.set_id, ModelComponentHandle.set_links, ModelComponentHandle.set_tags, ModelComponentsService.clone, ModelComponentsService.get, ModelComponentsService.get_by_immutable_id, ModelComponentsService.list, ModelComponentsService.search

Member	Kind	Description
id	property
immutable_id	property
url	property
kind	property
description	property
display_name	property
tags	property
links	property
definition	property	Human-readable one-line rendering of this component's core content.
diagnostics	property	Diagnostics attached to this component in its current cached state.
has_tag	method
has_link	method	Return True if this component already has the given link.
refresh	method	Refresh this handle from the latest model head and return self.
delete	method	Delete this component from the model.
clone	method	Clone this component with new_id and persist immediately.
set_id	method	Rename the component id and persist immediately.
set_description	method	Set the component description and persist immediately.
set_display_name	method	Set the human-readable display name and persist immediately.
add_tag	method	Add a model tag to this component if not already present.
remove_tag	method	Remove a model tag from this component if present.
set_tags	method	Replace this component's tags with the provided model tags.
add_link	method	Add a link to this component if not already present.
remove_link	method	Remove a link from this component if already present.
set_links	method	Replace this component's links with the provided links.
clear_links	method	Remove all traceability links from this component.

id

Type: str

immutable_id

Type: str | None

url

Type: str

kind

Type: str

description

Type: str | None

display_name

Type: str | None

tags

Type: list['Tag']

links

Type: list[str]

definition

Type: str | None

Human-readable one-line rendering of this component's core content.

The underlying field varies by component kind (a parameter's formula, an ODE's right_side, an algebraic rule's equation, etc.). Returns None for the base Component and for any kind without a natural single-field definition; typed subclasses override this.

diagnostics

Type: ModelDiagnostics

Diagnostics attached to this component in its current cached state.

Returns a ModelDiagnostics view that supports the same filtering and printing as the model-wide view::

param.diagnostics.errors()
print(param.diagnostics)

The view is built from the handle's last-fetched payload and does not make a network request. Call refresh first if you need the latest server state.

has_tag

has_tag(tag: str | 'Tag) -> bool

has_link

has_link(link: str | ProjectItem) -> bool

Return True if this component already has the given link.

refresh

refresh() -> ModelComponentHandle

Refresh this handle from the latest model head and return self.

delete

delete(*, version: str | dict | None = None) -> None

Delete this component from the model.

After deletion, this handle becomes invalid and any further method call raises DeletedHandleError.

clone

clone(*, new_id: str) -> ModelComponentHandle

Clone this component with new_id and persist immediately.

set_id

set_id(
    new_id: str, *, version: str | dict | None = None
) -> ModelComponentHandle

Rename the component id and persist immediately.

set_description

set_description(
    description: str | None, *, version: str | dict | None = None
) -> ModelComponentHandle

Set the component description and persist immediately.

set_display_name

set_display_name(
    display_name: str | None, *, version: str | dict | None = None
) -> ModelComponentHandle

Set the human-readable display name and persist immediately.

add_tag

add_tag(tag: str | 'Tag, *, version: str | dict | None = None) -> ModelComponentHandle

Add a model tag to this component if not already present.

remove_tag

remove_tag(tag: str | 'Tag, *, version: str | dict | None = None) -> ModelComponentHandle

Remove a model tag from this component if present.

set_tags

set_tags(
    tags: list[str | "Tag"], *, version: str | dict | None = None
) -> ModelComponentHandle

Replace this component's tags with the provided model tags.

add_link

add_link(
    link: str | ProjectItem, *, version: str | dict | None = None
) -> ModelComponentHandle

Add a link to this component if not already present.

remove_link

remove_link(
    link: str | ProjectItem, *, version: str | dict | None = None
) -> ModelComponentHandle

Remove a link from this component if already present.

set_links

set_links(
    links: list[str | ProjectItem], *, version: str | dict | None = None
) -> ModelComponentHandle

Replace this component's links with the provided links.

clear_links

clear_links(
    *, version: str | dict | None = None
) -> ModelComponentHandle

Remove all traceability links from this component.

ParameterComponent

Typed persisted handle for Parameter components.

Returned by: ModelComponentsService.create_parameter, ModelComponentsService.get_parameter, ModelComponentsService.list_parameters, ParameterComponent.clone, ParameterComponent.set_constant, ParameterComponent.set_formula, ParameterComponent.set_scale, ParameterComponent.set_tolerance, ParameterComponent.set_unit, ParameterComponent.update

Also has every member of ModelComponentHandle.

Member	Kind	Description
formula	property
definition	property
unit	property
constant	property
scale	property
tolerance	property
update	method	Apply multiple parameter field updates in one API call.
set_formula	method	Set parameter formula and persist immediately.
set_unit	method	Set parameter unit and persist immediately.
set_constant	method	Set parameter constant flag and persist immediately.
set_scale	method	Set parameter scale and persist immediately.
set_tolerance	method	Set parameter tolerance and persist immediately.
clone	method	Clone this parameter and return a typed parameter handle.

formula

Type: float | str

definition

Type: str | None

unit

Type: str | None

constant

Type: bool | None

scale

Type: float | str | None

tolerance

Type: float

update

update(
    *,
    formula: float | str | _UnsetType = _UNSET,
    unit: str | None | _UnsetType = _UNSET,
    constant: bool | None | _UnsetType = _UNSET,
    scale: float | str | None | _UnsetType = _UNSET,
    tolerance: float | _UnsetType = _UNSET,
    id: str | None | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> ParameterComponent

Apply multiple parameter field updates in one API call.

This is the recommended path for multi-field edits because fluent set_* chaining performs one request per call.

Example

p = model.components.get_parameter("k_clearance")
p.update(formula="CL / V", unit="L/h", description="retuned")

set_formula

set_formula(
    formula: float | str, *, version: str | dict | None = None
) -> ParameterComponent

Set parameter formula and persist immediately.

set_unit

set_unit(
    unit: str, *, version: str | dict | None = None
) -> ParameterComponent

Set parameter unit and persist immediately.

set_constant

set_constant(
    constant: bool, *, version: str | dict | None = None
) -> ParameterComponent

Set parameter constant flag and persist immediately.

set_scale

set_scale(
    scale: float | str | None, *, version: str | dict | None = None
) -> ParameterComponent

Set parameter scale and persist immediately.

set_tolerance

set_tolerance(
    tolerance: float, *, version: str | dict | None = None
) -> ParameterComponent

Set parameter tolerance and persist immediately.

clone

clone(*, new_id: str) -> ParameterComponent

Clone this parameter and return a typed parameter handle.

SpeciesComponent

Typed persisted handle for Species components.

Returned by: ModelComponentsService.create_species, ModelComponentsService.get_species, ModelComponentsService.list_species, SpeciesComponent.clone, SpeciesComponent.set_boundary_condition, SpeciesComponent.set_compartment, SpeciesComponent.set_constant, SpeciesComponent.set_conversion_factor, SpeciesComponent.set_initial_condition, SpeciesComponent.set_molar_mass, SpeciesComponent.set_scale, SpeciesComponent.set_tolerance, SpeciesComponent.set_unit, SpeciesComponent.update

Also has every member of ModelComponentHandle.

Member	Kind	Description
compartment	property
initial_condition	property
unit	property
constant	property
boundary_condition	property
conversion_factor	property
molar_mass	property
scale	property
tolerance	property
definition	property
update	method	Apply multiple species field updates in one API call.
set_compartment	method	Set species compartment and persist immediately.
set_initial_condition	method	Set species initial condition and persist immediately.
set_unit	method	Set species unit and persist immediately.
set_constant	method	Set species constant flag and persist immediately.
set_boundary_condition	method	Set species boundary condition and persist immediately.
set_conversion_factor	method	Set species conversion factor and persist immediately.
set_molar_mass	method	Set species molar mass and persist immediately.
set_scale	method	Set species scale and persist immediately.
set_tolerance	method	Set species tolerance and persist immediately.
clone	method	Clone this species and return a typed species handle.

compartment

Type: str

initial_condition

Type: float | str

unit

Type: str | None

constant

Type: bool | None

boundary_condition

Type: bool | None

conversion_factor

Type: str | None

molar_mass

Type: float | str | None

scale

Type: float | str | None

tolerance

Type: float

definition

Type: str | None

update

update(
    *,
    compartment: str | _UnsetType = _UNSET,
    initial_condition: float | str | _UnsetType = _UNSET,
    unit: str | None | _UnsetType = _UNSET,
    constant: bool | None | _UnsetType = _UNSET,
    boundary_condition: bool | None | _UnsetType = _UNSET,
    conversion_factor: str | None | _UnsetType = _UNSET,
    molar_mass: float | str | None | _UnsetType = _UNSET,
    scale: float | str | None | _UnsetType = _UNSET,
    tolerance: float | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> SpeciesComponent

Apply multiple species field updates in one API call.

set_compartment

set_compartment(
    compartment: str, *, version: str | dict | None = None
) -> SpeciesComponent

Set species compartment and persist immediately.

set_initial_condition

set_initial_condition(
    initial_condition: float | str, *, version: str | dict | None = None
) -> SpeciesComponent

Set species initial condition and persist immediately.

set_unit

set_unit(
    unit: str | None, *, version: str | dict | None = None
) -> SpeciesComponent

Set species unit and persist immediately.

set_constant

set_constant(
    constant: bool | None, *, version: str | dict | None = None
) -> SpeciesComponent

Set species constant flag and persist immediately.

set_boundary_condition

set_boundary_condition(
    boundary_condition: bool | None, *, version: str | dict | None = None
) -> SpeciesComponent

Set species boundary condition and persist immediately.

set_conversion_factor

set_conversion_factor(
    conversion_factor: str | None, *, version: str | dict | None = None
) -> SpeciesComponent

Set species conversion factor and persist immediately.

set_molar_mass

set_molar_mass(
    molar_mass: float | str | None, *, version: str | dict | None = None
) -> SpeciesComponent

Set species molar mass and persist immediately.

set_scale

set_scale(
    scale: float | str | None, *, version: str | dict | None = None
) -> SpeciesComponent

Set species scale and persist immediately.

set_tolerance

set_tolerance(
    tolerance: float, *, version: str | dict | None = None
) -> SpeciesComponent

Set species tolerance and persist immediately.

clone

clone(*, new_id: str) -> SpeciesComponent

Clone this species and return a typed species handle.

CompartmentComponent

Typed persisted handle for Compartment components.

Returned by: CompartmentComponent.clone, CompartmentComponent.set_constant, CompartmentComponent.set_scale, CompartmentComponent.set_tolerance, CompartmentComponent.set_unit, CompartmentComponent.set_volume, CompartmentComponent.update, ModelComponentsService.create_compartment, ModelComponentsService.get_compartment, ModelComponentsService.list_compartments

Also has every member of ModelComponentHandle.

Member	Kind	Description
volume	property
unit	property
constant	property
scale	property
tolerance	property
definition	property
update	method	Apply multiple compartment field updates in one API call.
set_volume	method	Set compartment volume and persist immediately.
set_unit	method	Set compartment unit and persist immediately.
set_constant	method	Set compartment constant flag and persist immediately.
set_scale	method	Set compartment scale and persist immediately.
set_tolerance	method	Set compartment tolerance and persist immediately.
clone	method	Clone this compartment and return a typed compartment handle.

volume

Type: float | str

unit

Type: str | None

constant

Type: bool | None

scale

Type: float | str | None

tolerance

Type: float

definition

Type: str | None

update

update(
    *,
    volume: float | str | _UnsetType = _UNSET,
    unit: str | None | _UnsetType = _UNSET,
    constant: bool | None | _UnsetType = _UNSET,
    scale: float | str | None | _UnsetType = _UNSET,
    tolerance: float | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> CompartmentComponent

Apply multiple compartment field updates in one API call.

set_volume

set_volume(
    volume: float | str, *, version: str | dict | None = None
) -> CompartmentComponent

Set compartment volume and persist immediately.

set_unit

set_unit(
    unit: str | None, *, version: str | dict | None = None
) -> CompartmentComponent

Set compartment unit and persist immediately.

set_constant

set_constant(
    constant: bool | None, *, version: str | dict | None = None
) -> CompartmentComponent

Set compartment constant flag and persist immediately.

set_scale

set_scale(
    scale: float | str | None, *, version: str | dict | None = None
) -> CompartmentComponent

Set compartment scale and persist immediately.

set_tolerance

set_tolerance(
    tolerance: float, *, version: str | dict | None = None
) -> CompartmentComponent

Set compartment tolerance and persist immediately.

clone

clone(*, new_id: str) -> CompartmentComponent

Clone this compartment and return a typed compartment handle.

ReactionComponent

Typed persisted handle for Reaction components.

Returned by: ModelComponentsService.create_competitive_inhibition_reaction, ModelComponentsService.create_enzymatic_activation_reaction, ModelComponentsService.create_general_reaction, ModelComponentsService.create_hill_equation_reaction, ModelComponentsService.create_mass_action_reaction, ModelComponentsService.create_michaelis_menten_reaction, ModelComponentsService.create_mixed_inhibition_reaction, ModelComponentsService.create_reversible_michaelis_menten_reaction, ModelComponentsService.create_uncompetitive_inhibition_reaction, ModelComponentsService.get_reaction, ModelComponentsService.list_reactions, ReactionComponent.clone, ReactionComponent.set_competitive_inhibition_kinetics, ReactionComponent.set_enzymatic_activation_kinetics, ReactionComponent.set_filter, ReactionComponent.set_general_kinetics, ReactionComponent.set_hill_equation_kinetics, ReactionComponent.set_kinetics, ReactionComponent.set_mass_action_kinetics, ReactionComponent.set_michaelis_menten_kinetics, ReactionComponent.set_mixed_inhibition_kinetics, ReactionComponent.set_rate_multiplier, ReactionComponent.set_reversible_michaelis_menten_kinetics, ReactionComponent.set_uncompetitive_inhibition_kinetics, ReactionComponent.update

Also has every member of ModelComponentHandle.

Member	Kind	Description
kinetics	property
kinetics_dict	property
filter	property
rate_multiplier	property
definition	property
update	method	Apply multiple reaction field updates in one API call.
set_kinetics	method	Set full reaction kinetics and persist immediately.
set_general_kinetics	method	Set General kinetics and persist immediately.
set_mass_action_kinetics	method	Set MassAction kinetics and persist immediately.
set_michaelis_menten_kinetics	method	Set MichaelisMenten kinetics and persist immediately.
set_reversible_michaelis_menten_kinetics	method	Set ReversibleMichaelisMenten kinetics and persist immediately.
set_hill_equation_kinetics	method	Set HillEquation kinetics and persist immediately.
set_enzymatic_activation_kinetics	method	Set EnzymaticActivation kinetics and persist immediately.
set_competitive_inhibition_kinetics	method	Set CompetitiveInhibition kinetics and persist immediately.
set_uncompetitive_inhibition_kinetics	method	Set UncompetitiveInhibition kinetics and persist immediately.
set_mixed_inhibition_kinetics	method	Set MixedInhibition kinetics and persist immediately.
set_filter	method	Set reaction filter and persist immediately.
set_rate_multiplier	method	Set reaction rate multiplier and persist immediately.
clone	method	Clone this reaction and return a typed reaction handle.

kinetics

Type: KineticsPayload

kinetics_dict

Type: dict[str, object]

filter

Type: str | None

rate_multiplier

Type: float | str | None

definition

Type: str | None

update

update(
    *,
    kinetics: KineticsPayload | dict[str, object] | _UnsetType = _UNSET,
    filter: str | None | _UnsetType = _UNSET,
    rate_multiplier: float | str | None | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> ReactionComponent

Apply multiple reaction field updates in one API call.

set_kinetics

set_kinetics(
    kinetics: KineticsPayload | dict[str, object],
    *,
    version: str | dict | None = None
) -> ReactionComponent

Set full reaction kinetics and persist immediately.

Prefer the canonical set_*_kinetics methods for each law.

set_general_kinetics

set_general_kinetics(
    *,
    reactants: dict[str, Any],
    products: dict[str, Any],
    rate: float | str,
    version: str | dict | None = None
) -> ReactionComponent

Set General kinetics and persist immediately.

set_mass_action_kinetics

set_mass_action_kinetics(
    *,
    reactants: dict[str, Any],
    products: dict[str, Any],
    k_plus: str,
    k_minus: str | None = None,
    version: str | dict | None = None
) -> ReactionComponent

Set MassAction kinetics and persist immediately.

set_michaelis_menten_kinetics

set_michaelis_menten_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    k_cat: str,
    k_m: str,
    version: str | dict | None = None
) -> ReactionComponent

Set MichaelisMenten kinetics and persist immediately.

set_reversible_michaelis_menten_kinetics

set_reversible_michaelis_menten_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    k_cat: str,
    k_m: str,
    k_inv: str,
    k_p: str,
    version: str | dict | None = None
) -> ReactionComponent

Set ReversibleMichaelisMenten kinetics and persist immediately.

set_hill_equation_kinetics

set_hill_equation_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    k_cat: str,
    k_m: str,
    hill_coefficient: str,
    version: str | dict | None = None
) -> ReactionComponent

Set HillEquation kinetics and persist immediately.

set_enzymatic_activation_kinetics

set_enzymatic_activation_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    activator: str,
    k_cat: str,
    k_m: str,
    k_a: str,
    version: str | dict | None = None
) -> ReactionComponent

Set EnzymaticActivation kinetics and persist immediately.

set_competitive_inhibition_kinetics

set_competitive_inhibition_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    inhibitor: str,
    k_cat: str,
    k_m: str,
    k_i_enzyme: str,
    version: str | dict | None = None
) -> ReactionComponent

Set CompetitiveInhibition kinetics and persist immediately.

set_uncompetitive_inhibition_kinetics

set_uncompetitive_inhibition_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    inhibitor: str,
    k_cat: str,
    k_m: str,
    k_i_enzymatic_complex: str,
    version: str | dict | None = None
) -> ReactionComponent

Set UncompetitiveInhibition kinetics and persist immediately.

set_mixed_inhibition_kinetics

set_mixed_inhibition_kinetics(
    *,
    substrate: str,
    product: str,
    enzyme: str,
    inhibitor: str,
    k_cat: str,
    k_m: str,
    k_i_enzyme: str,
    k_i_enzymatic_complex: str,
    version: str | dict | None = None
) -> ReactionComponent

Set MixedInhibition kinetics and persist immediately.

set_filter

set_filter(
    filter: str | None, *, version: str | dict | None = None
) -> ReactionComponent

Set reaction filter and persist immediately.

set_rate_multiplier

set_rate_multiplier(
    rate_multiplier: float | str | None, *, version: str | dict | None = None
) -> ReactionComponent

Set reaction rate multiplier and persist immediately.

clone

clone(*, new_id: str) -> ReactionComponent

Clone this reaction and return a typed reaction handle.

EventComponent

Typed persisted handle for Event components.

Returned by: EventComponent.clone, EventComponent.set_condition_trigger, EventComponent.set_initial_value, EventComponent.set_persistent, EventComponent.set_priority, EventComponent.set_record, EventComponent.set_solver_stop, EventComponent.set_time_trigger, EventComponent.set_updates, EventComponent.set_use_values_from_trigger_time, EventComponent.update, ModelComponentsService.create_event, ModelComponentsService.get_event, ModelComponentsService.list_events

Also has every member of ModelComponentHandle.

Member	Kind	Description
updates	property
condition_trigger	property
time_trigger	property
time_trigger_dict	property
priority	property
solver_stop	property
persistent	property
initial_value	property
use_values_from_trigger_time	property
record	property
definition	property
update	method	Apply multiple event field updates in one API call.
set_updates	method	Set event updates and persist immediately.
set_condition_trigger	method	Set event condition trigger and persist immediately.
set_time_trigger	method	Set event time trigger and persist immediately.
set_priority	method	Set event priority and persist immediately.
set_persistent	method	Set event persistent flag and persist immediately.
set_solver_stop	method	Set event solver-stop behavior and persist immediately.
set_initial_value	method	Set event initial value flag and persist immediately.
set_use_values_from_trigger_time	method	Set event trigger-time value usage flag and persist immediately.
set_record	method	Set event record flag and persist immediately.
clone	method	Clone this event and return a typed event handle.

updates

Type: dict[str, Any]

condition_trigger

Type: str | None

time_trigger

Type: TimeTriggerPayload | None

time_trigger_dict

Type: dict[str, float | str] | None

priority

Type: float | str | None

solver_stop

Type: str | None

persistent

Type: bool | None

initial_value

Type: bool | None

use_values_from_trigger_time

Type: bool | None

record

Type: bool | None

definition

Type: str | None

update

update(
    *,
    updates: dict[str, Any] | _UnsetType = _UNSET,
    condition_trigger: str | None | _UnsetType = _UNSET,
    time_trigger_first_time: float | str | None | _UnsetType = _UNSET,
    time_trigger_every: float | str | None | _UnsetType = _UNSET,
    time_trigger_count: float | str | None | _UnsetType = _UNSET,
    time_trigger_until: float | str | None | _UnsetType = _UNSET,
    priority: float | str | None | _UnsetType = _UNSET,
    solver_stop: str | _UnsetType = _UNSET,
    persistent: bool | None | _UnsetType = _UNSET,
    initial_value: bool | None | _UnsetType = _UNSET,
    use_values_from_trigger_time: bool | None | _UnsetType = _UNSET,
    record: bool | None | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> EventComponent

Apply multiple event field updates in one API call.

For optional trigger/behavior flags, passing None explicitly sets the field to null in the payload. Leaving a field as _UNSET leaves it unchanged on the server.

Time trigger combinations follow build_time_trigger rules: first_time only; first_time + every; first_time + every + count; first_time + every + until. count and until are mutually exclusive. count=1 without every is normalized as a one-shot trigger.

set_updates

set_updates(
    updates: dict[str, Any], *, version: str | dict | None = None
) -> EventComponent

Set event updates and persist immediately.

set_condition_trigger

set_condition_trigger(
    condition_trigger: str | None, *, version: str | dict | None = None
) -> EventComponent

Set event condition trigger and persist immediately.

set_time_trigger

set_time_trigger(
    *,
    first_time: float | str | None,
    every: float | str | None = None,
    count: float | str | None = None,
    until: float | str | None = None,
    version: str | dict | None = None
) -> EventComponent

Set event time trigger and persist immediately.

Accepted combinations are: first_time only; first_time + every; first_time + every + count; first_time + every + until. count and until are mutually exclusive. count=1 without every is normalized as a one-shot trigger.

set_priority

set_priority(
    priority: float | str | None, *, version: str | dict | None = None
) -> EventComponent

Set event priority and persist immediately.

set_persistent

set_persistent(
    persistent: bool | None, *, version: str | dict | None = None
) -> EventComponent

Set event persistent flag and persist immediately.

set_solver_stop

set_solver_stop(
    solver_stop: str, *, version: str | dict | None = None
) -> EventComponent

Set event solver-stop behavior and persist immediately.

set_initial_value

set_initial_value(
    initial_value: bool | None, *, version: str | dict | None = None
) -> EventComponent

Set event initial value flag and persist immediately.

set_use_values_from_trigger_time

set_use_values_from_trigger_time(
    use_values_from_trigger_time: bool | None,
    *,
    version: str | dict | None = None
) -> EventComponent

Set event trigger-time value usage flag and persist immediately.

set_record

set_record(
    record: bool | None, *, version: str | dict | None = None
) -> EventComponent

Set event record flag and persist immediately.

clone

clone(*, new_id: str) -> EventComponent

Clone this event and return a typed event handle.

OdeComponent

Typed persisted handle for Ode components.

Returned by: ModelComponentsService.create_ode, ModelComponentsService.get_ode, ModelComponentsService.list_odes, OdeComponent.clone, OdeComponent.set_filter, OdeComponent.set_left_side, OdeComponent.set_right_side, OdeComponent.update

Also has every member of ModelComponentHandle.

Member	Kind	Description
left_side	property
right_side	property
filter	property
definition	property
update	method	Apply multiple ODE field updates in one API call.
set_left_side	method	Set ODE left side and persist immediately.
set_right_side	method	Set ODE right side and persist immediately.
set_filter	method	Set ODE filter and persist immediately.
clone	method	Clone this ODE and return a typed ODE handle.

left_side

Type: str

right_side

Type: float | str

filter

Type: str | None

definition

Type: str | None

update

update(
    *,
    left_side: str | _UnsetType = _UNSET,
    right_side: float | str | _UnsetType = _UNSET,
    filter: str | None | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> OdeComponent

Apply multiple ODE field updates in one API call.

set_left_side

set_left_side(
    left_side: str, *, version: str | dict | None = None
) -> OdeComponent

Set ODE left side and persist immediately.

set_right_side

set_right_side(
    right_side: float | str, *, version: str | dict | None = None
) -> OdeComponent

Set ODE right side and persist immediately.

set_filter

set_filter(
    filter: str | None, *, version: str | dict | None = None
) -> OdeComponent

Set ODE filter and persist immediately.

clone

clone(*, new_id: str) -> OdeComponent

Clone this ODE and return a typed ODE handle.

CategoricalParameterComponent

Typed persisted handle for CategoricalParameter components.

Returned by: CategoricalParameterComponent.clone, CategoricalParameterComponent.set_available_levels, CategoricalParameterComponent.set_level, CategoricalParameterComponent.update, ModelComponentsService.create_categorical_parameter, ModelComponentsService.get_categorical_parameter, ModelComponentsService.list_categorical_parameters

Also has every member of ModelComponentHandle.

Member	Kind	Description
level	property
available_levels	property
definition	property
update	method	Apply multiple categorical parameter field updates in one API call.
set_level	method	Set categorical parameter level and persist immediately.
set_available_levels	method	Set available levels and persist immediately.
clone	method	Clone this categorical parameter and return a typed handle.

level

Type: str

available_levels

Type: list[str]

definition

Type: str | None

update

update(
    *,
    level: str | _UnsetType = _UNSET,
    available_levels: list[str] | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> CategoricalParameterComponent

Apply multiple categorical parameter field updates in one API call.

set_level

set_level(
    level: str, *, version: str | dict | None = None
) -> CategoricalParameterComponent

Set categorical parameter level and persist immediately.

set_available_levels

set_available_levels(
    available_levels: list[str], *, version: str | dict | None = None
) -> CategoricalParameterComponent

Set available levels and persist immediately.

clone

clone(*, new_id: str) -> CategoricalParameterComponent

Clone this categorical parameter and return a typed handle.

BaselineCheckComponent

Typed persisted handle for BaselineCheck components.

Returned by: BaselineCheckComponent.clone, BaselineCheckComponent.set_condition, BaselineCheckComponent.update, ModelComponentsService.create_baseline_check, ModelComponentsService.get_baseline_check, ModelComponentsService.list_baseline_checks

Also has every member of ModelComponentHandle.

Member	Kind	Description
condition	property
definition	property
update	method	Apply multiple baseline check field updates in one API call.
set_condition	method	Set baseline check condition and persist immediately.
clone	method	Clone this baseline check and return a typed handle.

condition

Type: str

definition

Type: str | None

update

update(
    *,
    condition: str | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> BaselineCheckComponent

Apply multiple baseline check field updates in one API call.

set_condition

set_condition(
    condition: str, *, version: str | dict | None = None
) -> BaselineCheckComponent

Set baseline check condition and persist immediately.

clone

clone(*, new_id: str) -> BaselineCheckComponent

Clone this baseline check and return a typed handle.

AlgebraicRuleComponent

Typed persisted handle for AlgebraicRule components.

Returned by: AlgebraicRuleComponent.clone, AlgebraicRuleComponent.set_equation, AlgebraicRuleComponent.set_filter, AlgebraicRuleComponent.update, ModelComponentsService.create_algebraic_rule, ModelComponentsService.get_algebraic_rule, ModelComponentsService.list_algebraic_rules

Also has every member of ModelComponentHandle.

Member	Kind	Description
equation	property
filter	property
definition	property
update	method	Apply multiple algebraic rule field updates in one API call.
set_equation	method	Set algebraic rule equation and persist immediately.
set_filter	method	Set algebraic rule filter and persist immediately.
clone	method	Clone this algebraic rule and return a typed handle.

equation

Type: float | str | None

filter

Type: str | None

definition

Type: str | None

update

update(
    *,
    equation: float | str | _UnsetType = _UNSET,
    filter: str | None | _UnsetType = _UNSET,
    id: str | _UnsetType = _UNSET,
    description: str | None | _UnsetType = _UNSET,
    display_name: str | None | _UnsetType = _UNSET,
    version: str | dict | None = None
) -> AlgebraicRuleComponent

Apply multiple algebraic rule field updates in one API call.

set_equation

set_equation(
    equation: float | str, *, version: str | dict | None = None
) -> AlgebraicRuleComponent

Set algebraic rule equation and persist immediately.

set_filter

set_filter(
    filter: str | None, *, version: str | dict | None = None
) -> AlgebraicRuleComponent

Set algebraic rule filter and persist immediately.

clone

clone(*, new_id: str) -> AlgebraicRuleComponent

Clone this algebraic rule and return a typed handle.