MeshLib Rust Docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
meshlib::PrecipitationSimulator_SimulationStep Struct Reference
Inheritance diagram for meshlib::PrecipitationSimulator_SimulationStep:

Public Member Functions

auto assign_from_another (_other:&meshlib::PrecipitationSimulator_SimulationStep) -> &mut meshlib::PrecipitationSimulator_SimulationStep
auto event () const -> &meshlib::PrecipitationSimulator_Event
auto event_mut () -> &mut meshlib::PrecipitationSimulator_Event
void set_event (value:meshlib::PrecipitationSimulator_Event)
auto amount () const -> &f32
auto amount_mut () -> &mut f32
void set_amount (value:f32)
auto basin () const -> &meshlib::GraphVertId
auto basin_mut () -> &mut meshlib::GraphVertId
void set_basin (value:meshlib::GraphVertId)
auto nei_basin () const -> &meshlib::GraphVertId
auto nei_basin_mut () -> &mut meshlib::GraphVertId
void set_nei_basin (value:meshlib::GraphVertId)

Static Public Member Functions

static auto new () -> meshlib::Owned< meshlib::PrecipitationSimulator_SimulationStep >
static auto construct_from (event:meshlib::PrecipitationSimulator_Event, amount:f32, basin:meshlib::GraphVertId, neiBasin:meshlib::GraphVertId) -> meshlib::Owned< meshlib::PrecipitationSimulator_SimulationStep >
static auto construct_from_another (_other:&meshlib::PrecipitationSimulator_SimulationStep) -> meshlib::Owned< meshlib::PrecipitationSimulator_SimulationStep >
Static Public Member Functions inherited from meshlib::CppClass
static void destroy (ptr:*mut Self)
Static Public Member Functions inherited from meshlib::CppCopy
static auto copy (ptr:*const Self) -> *mut Self

Detailed Description

Generated from class MR::PrecipitationSimulator::SimulationStep.

Generated from class MR::PrecipitationSimulator::SimulationStep. Heap-allocated instances are held in Owned<PrecipitationSimulator_SimulationStep>.

Member Function Documentation

◆ amount()

auto meshlib::PrecipitationSimulator_SimulationStep::amount ( ) const -> &f32

< amount of precipitation (in same units as mesh coordinates and water level) Returns a pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named amount.

Calls MR_PrecipitationSimulator_SimulationStep_Get_amount(). The reference to this object might be preserved as the return value.

◆ amount_mut()

auto meshlib::PrecipitationSimulator_SimulationStep::amount_mut ( ) -> &mut f32

< amount of precipitation (in same units as mesh coordinates and water level) Returns a mutable pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named amount.

Calls MR_PrecipitationSimulator_SimulationStep_GetMutable_amount(). The reference to this object might be preserved as the return value.

◆ assign_from_another()

auto meshlib::PrecipitationSimulator_SimulationStep::assign_from_another ( _other:&meshlib::PrecipitationSimulator_SimulationStep ) -> &mut meshlib::PrecipitationSimulator_SimulationStep

Generated from method MR::PrecipitationSimulator::SimulationStep::operator=.

Calls MR_PrecipitationSimulator_SimulationStep_AssignFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in this object.

◆ basin()

auto meshlib::PrecipitationSimulator_SimulationStep::basin ( ) const -> &meshlib::GraphVertId

< BasinFull: this basin just became full < Merge: this basin just absorbed the other basin Returns a pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named basin.

Calls MR_PrecipitationSimulator_SimulationStep_Get_basin(). The reference to this object might be preserved as the return value.

◆ basin_mut()

auto meshlib::PrecipitationSimulator_SimulationStep::basin_mut ( ) -> &mut meshlib::GraphVertId

< BasinFull: this basin just became full < Merge: this basin just absorbed the other basin Returns a mutable pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named basin.

Calls MR_PrecipitationSimulator_SimulationStep_GetMutable_basin(). The reference to this object might be preserved as the return value.

◆ construct_from()

auto meshlib::PrecipitationSimulator_SimulationStep::construct_from ( event:meshlib::PrecipitationSimulator_Event ,
amount:f32 ,
basin:meshlib::GraphVertId ,
neiBasin:meshlib::GraphVertId  ) -> meshlib::Owned< meshlib::PrecipitationSimulator_SimulationStep >
static

Constructs MR::PrecipitationSimulator::SimulationStep elementwise.

Calls MR_PrecipitationSimulator_SimulationStep_ConstructFrom(). The reference to the parameter event might be preserved in the constructed object. The reference to the parameter basin might be preserved in the constructed object. The reference to the parameter neiBasin might be preserved in the constructed object.

◆ construct_from_another()

auto meshlib::PrecipitationSimulator_SimulationStep::construct_from_another ( _other:&meshlib::PrecipitationSimulator_SimulationStep ) -> meshlib::Owned< meshlib::PrecipitationSimulator_SimulationStep >
static

Generated from constructor MR::PrecipitationSimulator::SimulationStep::SimulationStep.

Calls MR_PrecipitationSimulator_SimulationStep_ConstructFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

◆ event()

auto meshlib::PrecipitationSimulator_SimulationStep::event ( ) const -> &meshlib::PrecipitationSimulator_Event

Returns a pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named event.

Calls MR_PrecipitationSimulator_SimulationStep_Get_event(). The reference to this object might be preserved as the return value.

◆ event_mut()

auto meshlib::PrecipitationSimulator_SimulationStep::event_mut ( ) -> &mut meshlib::PrecipitationSimulator_Event

Returns a mutable pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named event.

Calls MR_PrecipitationSimulator_SimulationStep_GetMutable_event(). The reference to this object might be preserved as the return value.

◆ nei_basin()

auto meshlib::PrecipitationSimulator_SimulationStep::nei_basin ( ) const -> &meshlib::GraphVertId

< BasinFull: the flow from full basin will first go here (may be not the last destination) < Merge: this basin was just absorbed Returns a pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named neiBasin.

Calls MR_PrecipitationSimulator_SimulationStep_Get_neiBasin(). The reference to this object might be preserved as the return value.

◆ nei_basin_mut()

auto meshlib::PrecipitationSimulator_SimulationStep::nei_basin_mut ( ) -> &mut meshlib::GraphVertId

< BasinFull: the flow from full basin will first go here (may be not the last destination) < Merge: this basin was just absorbed Returns a mutable pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named neiBasin.

Calls MR_PrecipitationSimulator_SimulationStep_GetMutable_neiBasin(). The reference to this object might be preserved as the return value.

◆ new()

auto meshlib::PrecipitationSimulator_SimulationStep::new ( ) -> meshlib::Owned< meshlib::PrecipitationSimulator_SimulationStep >
static

Constructs an empty (default-constructed) instance.

Calls MR_PrecipitationSimulator_SimulationStep_DefaultConstruct().

◆ set_amount()

void meshlib::PrecipitationSimulator_SimulationStep::set_amount ( value:f32 )

< amount of precipitation (in same units as mesh coordinates and water level) Modifies a member variable of class MR::PrecipitationSimulator::SimulationStep named amount.

Calls MR_PrecipitationSimulator_SimulationStep_Set_amount().

◆ set_basin()

void meshlib::PrecipitationSimulator_SimulationStep::set_basin ( value:meshlib::GraphVertId )

< BasinFull: this basin just became full < Merge: this basin just absorbed the other basin Modifies a member variable of class MR::PrecipitationSimulator::SimulationStep named basin.

Calls MR_PrecipitationSimulator_SimulationStep_Set_basin(). The reference to the parameter value might be preserved in this object in element basin.

◆ set_event()

void meshlib::PrecipitationSimulator_SimulationStep::set_event ( value:meshlib::PrecipitationSimulator_Event )

Modifies a member variable of class MR::PrecipitationSimulator::SimulationStep named event.

Calls MR_PrecipitationSimulator_SimulationStep_Set_event(). The reference to the parameter value might be preserved in this object in element event.

◆ set_nei_basin()

void meshlib::PrecipitationSimulator_SimulationStep::set_nei_basin ( value:meshlib::GraphVertId )

< BasinFull: the flow from full basin will first go here (may be not the last destination) < Merge: this basin was just absorbed Modifies a member variable of class MR::PrecipitationSimulator::SimulationStep named neiBasin.

Calls MR_PrecipitationSimulator_SimulationStep_Set_neiBasin(). The reference to the parameter value might be preserved in this object in element neiBasin.

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