meshlib.PrecipitationSimulator_SimulationStep Class Reference

Inheritance diagram for meshlib.PrecipitationSimulator_SimulationStep:

Public Member Functions
	PrecipitationSimulator_SimulationStep (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
	PrecipitationSimulator_SimulationStep ()
	PrecipitationSimulator_SimulationStep (meshlib.PrecipitationSimulator_Event event, float amount, meshlib.GraphVertId basin, meshlib.GraphVertId neiBasin)
	PrecipitationSimulator_SimulationStep (meshlib.PrecipitationSimulator_SimulationStep _other)
meshlib.PrecipitationSimulator_SimulationStep	assignFromAnother (meshlib.PrecipitationSimulator_SimulationStep _other)
meshlib.PrecipitationSimulator_Event	event ()
void	setEvent (meshlib.PrecipitationSimulator_Event value)
float	amount ()
void	setAmount (float value)
meshlib.GraphVertId	basin ()
void	setBasin (meshlib.GraphVertId value)
meshlib.GraphVertId	neiBasin ()
void	setNeiBasin (meshlib.GraphVertId value)
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment	rawPointer ()
final boolean	isOwned ()
final void	close ()
final java.lang.foreign.MemorySegment	release ()

Additional Inherited Members
Protected Member Functions inherited from meshlib.CppObject
	CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

Detailed Description

Generated from class MR::PrecipitationSimulator::SimulationStep.

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

PrecipitationSimulator_SimulationStep() [1/4]

meshlib.PrecipitationSimulator_SimulationStep.PrecipitationSimulator_SimulationStep	(	java.lang.foreign.MemorySegment	ptr,
		boolean	owned,
		java.lang.Object	owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

PrecipitationSimulator_SimulationStep() [2/4]

meshlib.PrecipitationSimulator_SimulationStep.PrecipitationSimulator_SimulationStep

(

)

Constructs an empty (default-constructed) instance.

Calls MR_PrecipitationSimulator_SimulationStep_DefaultConstruct().

PrecipitationSimulator_SimulationStep() [3/4]

meshlib.PrecipitationSimulator_SimulationStep.PrecipitationSimulator_SimulationStep	(	meshlib.PrecipitationSimulator_Event	event,
		float	amount,
		meshlib.GraphVertId	basin,
		meshlib.GraphVertId	neiBasin )

Constructs MR::PrecipitationSimulator::SimulationStep elementwise. 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.

Calls MR_PrecipitationSimulator_SimulationStep_ConstructFrom().

PrecipitationSimulator_SimulationStep() [4/4]

meshlib.PrecipitationSimulator_SimulationStep.PrecipitationSimulator_SimulationStep

(

meshlib.PrecipitationSimulator_SimulationStep

_other

)

Generated from constructor MR::PrecipitationSimulator::SimulationStep::SimulationStep. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

Calls MR_PrecipitationSimulator_SimulationStep_ConstructFromAnother().

Member Function Documentation

amount()

float meshlib.PrecipitationSimulator_SimulationStep.amount

(

)

< 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. The reference to this object might be preserved as the return value.

Calls MR_PrecipitationSimulator_SimulationStep_Get_amount().

assignFromAnother()

meshlib.PrecipitationSimulator_SimulationStep meshlib.PrecipitationSimulator_SimulationStep.assignFromAnother

(

meshlib.PrecipitationSimulator_SimulationStep

_other

)

Generated from method MR::PrecipitationSimulator::SimulationStep::operator=. The reference to things referred to by the parameter _other (if any) might be preserved in this object.

Calls MR_PrecipitationSimulator_SimulationStep_AssignFromAnother().

basin()

meshlib.GraphVertId meshlib.PrecipitationSimulator_SimulationStep.basin

(

)

< 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. The reference to this object might be preserved as the return value.

Calls MR_PrecipitationSimulator_SimulationStep_Get_basin().

event()

meshlib.PrecipitationSimulator_Event meshlib.PrecipitationSimulator_SimulationStep.event

(

)

Returns a pointer to a member variable of class MR::PrecipitationSimulator::SimulationStep named event. The reference to this object might be preserved as the return value.

Calls MR_PrecipitationSimulator_SimulationStep_Get_event().

neiBasin()

meshlib.GraphVertId meshlib.PrecipitationSimulator_SimulationStep.neiBasin

(

)

< 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. The reference to this object might be preserved as the return value.

Calls MR_PrecipitationSimulator_SimulationStep_Get_neiBasin().

setAmount()

void meshlib.PrecipitationSimulator_SimulationStep.setAmount

(

float

value

)

< 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().

setBasin()

void meshlib.PrecipitationSimulator_SimulationStep.setBasin

(

meshlib.GraphVertId

value

)

< 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. The reference to the parameter value might be preserved in this object in element basin.

Calls MR_PrecipitationSimulator_SimulationStep_Set_basin().

setEvent()

void meshlib.PrecipitationSimulator_SimulationStep.setEvent

(

meshlib.PrecipitationSimulator_Event

value

)

Modifies a member variable of class MR::PrecipitationSimulator::SimulationStep named event. The reference to the parameter value might be preserved in this object in element event.

Calls MR_PrecipitationSimulator_SimulationStep_Set_event().

setNeiBasin()

void meshlib.PrecipitationSimulator_SimulationStep.setNeiBasin

(

meshlib.GraphVertId

value

)

< 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. The reference to the parameter value might be preserved in this object in element neiBasin.

Calls MR_PrecipitationSimulator_SimulationStep_Set_neiBasin().

---

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

• PrecipitationSimulator_SimulationStep.java