meshlib::WatershedGraph_BasinInfo Struct Reference

Inheritance diagram for meshlib::WatershedGraph_BasinInfo:

Public Member Functions
auto	assign_from_another (_other:&meshlib::WatershedGraph_BasinInfo) -> &mut meshlib::WatershedGraph_BasinInfo
auto	amount_till_overflow () const -> f32
auto	approx_level () const -> f32
void	update_acc_volume (amount:f32)
auto	lowest_vert () const -> &meshlib::VertId
auto	lowest_vert_mut () -> &mut meshlib::VertId
void	set_lowest_vert (value:meshlib::VertId)
auto	lowest_level () const -> &f32
auto	lowest_level_mut () -> &mut f32
void	set_lowest_level (value:f32)
auto	area () const -> &f32
auto	area_mut () -> &mut f32
void	set_area (value:f32)
auto	lowest_bd_level () const -> &f32
auto	lowest_bd_level_mut () -> &mut f32
void	set_lowest_bd_level (value:f32)
auto	max_volume () const -> &f32
auto	max_volume_mut () -> &mut f32
void	set_max_volume (value:f32)
auto	acc_volume () const -> &f32
auto	acc_volume_mut () -> &mut f32
void	set_acc_volume (value:f32)
auto	last_update_amount () const -> &f32
auto	last_update_amount_mut () -> &mut f32
void	set_last_update_amount (value:f32)
auto	last_merge_level () const -> &f32
auto	last_merge_level_mut () -> &mut f32
void	set_last_merge_level (value:f32)
auto	last_merge_volume () const -> &f32
auto	last_merge_volume_mut () -> &mut f32
void	set_last_merge_volume (value:f32)
auto	overflow_via () const -> &meshlib::GraphEdgeId
auto	overflow_via_mut () -> &mut meshlib::GraphEdgeId
void	set_overflow_via (value:meshlib::GraphEdgeId)

Static Public Member Functions
static auto	new () -> meshlib::Owned< meshlib::WatershedGraph_BasinInfo >
static auto	construct_from_another (_other:&meshlib::WatershedGraph_BasinInfo) -> meshlib::Owned< meshlib::WatershedGraph_BasinInfo >
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

associated with each vertex in graph Generated from class MR::WatershedGraph::BasinInfo.

Generated from class MR::WatershedGraph::BasinInfo. Heap-allocated instances are held in Owned<WatershedGraph_BasinInfo>.

Member Function Documentation

acc_volume()

auto meshlib::WatershedGraph_BasinInfo::acc_volume

(

)

const -> &f32

< accumulated water volume in the basin so far Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named accVolume.

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

acc_volume_mut()

auto meshlib::WatershedGraph_BasinInfo::acc_volume_mut

(

)

-> &mut f32

< accumulated water volume in the basin so far Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named accVolume.

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

amount_till_overflow()

auto meshlib::WatershedGraph_BasinInfo::amount_till_overflow

(

)

const -> f32

amount of precipitation (in same units as mesh coordinates and water level), which can be added before overflowing the basin Generated from method MR::WatershedGraph::BasinInfo::amountTillOverflow.

Calls MR_WatershedGraph_BasinInfo_amountTillOverflow().

approx_level()

auto meshlib::WatershedGraph_BasinInfo::approx_level

(

)

const -> f32

approximate current level of water (z-coordinate) in the basin Generated from method MR::WatershedGraph::BasinInfo::approxLevel.

Calls MR_WatershedGraph_BasinInfo_approxLevel().

area()

auto meshlib::WatershedGraph_BasinInfo::area

(

)

const -> &f32

< precipitation area that flows in this basin (and if it is full, continue flowing next) Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named area.

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

area_mut()

auto meshlib::WatershedGraph_BasinInfo::area_mut

(

)

-> &mut f32

< precipitation area that flows in this basin (and if it is full, continue flowing next) Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named area.

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

assign_from_another()

auto meshlib::WatershedGraph_BasinInfo::assign_from_another

(

_other:&meshlib::WatershedGraph_BasinInfo

)

-> &mut meshlib::WatershedGraph_BasinInfo

Generated from method MR::WatershedGraph::BasinInfo::operator=.

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

construct_from_another()

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

static

Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.

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

last_merge_level()

auto meshlib::WatershedGraph_BasinInfo::last_merge_level

(

)

const -> &f32

< water level in the basin when it was formed (by merge or creation) Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastMergeLevel.

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

last_merge_level_mut()

auto meshlib::WatershedGraph_BasinInfo::last_merge_level_mut

(

)

-> &mut f32

< water level in the basin when it was formed (by merge or creation) Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastMergeLevel.

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

last_merge_volume()

auto meshlib::WatershedGraph_BasinInfo::last_merge_volume

(

)

const -> &f32

< water volume in the basin when it was formed (by merge or creation) Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastMergeVolume.

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

last_merge_volume_mut()

auto meshlib::WatershedGraph_BasinInfo::last_merge_volume_mut

(

)

-> &mut f32

< water volume in the basin when it was formed (by merge or creation) Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastMergeVolume.

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

last_update_amount()

auto meshlib::WatershedGraph_BasinInfo::last_update_amount

(

)

const -> &f32

< the amount when accVolume was last updated Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastUpdateAmount.

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

last_update_amount_mut()

auto meshlib::WatershedGraph_BasinInfo::last_update_amount_mut

(

)

-> &mut f32

< the amount when accVolume was last updated Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastUpdateAmount.

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

lowest_bd_level()

auto meshlib::WatershedGraph_BasinInfo::lowest_bd_level

(

)

const -> &f32

< lowest position on the boundary of the basin Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestBdLevel.

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

lowest_bd_level_mut()

auto meshlib::WatershedGraph_BasinInfo::lowest_bd_level_mut

(

)

-> &mut f32

< lowest position on the boundary of the basin Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestBdLevel.

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

lowest_level()

auto meshlib::WatershedGraph_BasinInfo::lowest_level

(

)

const -> &f32

< lowest level (z-coordinate of lowestVert) in the basin Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestLevel.

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

lowest_level_mut()

auto meshlib::WatershedGraph_BasinInfo::lowest_level_mut

(

)

-> &mut f32

< lowest level (z-coordinate of lowestVert) in the basin Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestLevel.

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

lowest_vert()

auto meshlib::WatershedGraph_BasinInfo::lowest_vert

(

)

const -> &meshlib::VertId

< in the whole basin Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestVert.

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

lowest_vert_mut()

auto meshlib::WatershedGraph_BasinInfo::lowest_vert_mut

(

)

-> &mut meshlib::VertId

< in the whole basin Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestVert.

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

max_volume()

auto meshlib::WatershedGraph_BasinInfo::max_volume

(

)

const -> &f32

< full water volume to be accumulated in the basin till water reaches the lowest height on the boundary Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named maxVolume.

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

max_volume_mut()

auto meshlib::WatershedGraph_BasinInfo::max_volume_mut

(

)

-> &mut f32

< full water volume to be accumulated in the basin till water reaches the lowest height on the boundary Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named maxVolume.

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

new()

auto meshlib::WatershedGraph_BasinInfo::new ( ) -> meshlib::Owned< meshlib::WatershedGraph_BasinInfo >

static

Constructs an empty (default-constructed) instance.

Calls MR_WatershedGraph_BasinInfo_DefaultConstruct().

overflow_via()

auto meshlib::WatershedGraph_BasinInfo::overflow_via

(

)

const -> &meshlib::GraphEdgeId

< when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named overflowVia.

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

overflow_via_mut()

auto meshlib::WatershedGraph_BasinInfo::overflow_via_mut

(

)

-> &mut meshlib::GraphEdgeId

< when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary Returns a mutable pointer to a member variable of class MR::WatershedGraph::BasinInfo named overflowVia.

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

set_acc_volume()

void meshlib::WatershedGraph_BasinInfo::set_acc_volume

(

value:f32

)

< accumulated water volume in the basin so far Modifies a member variable of class MR::WatershedGraph::BasinInfo named accVolume.

Calls MR_WatershedGraph_BasinInfo_Set_accVolume().

set_area()

void meshlib::WatershedGraph_BasinInfo::set_area

(

value:f32

)

< precipitation area that flows in this basin (and if it is full, continue flowing next) Modifies a member variable of class MR::WatershedGraph::BasinInfo named area.

Calls MR_WatershedGraph_BasinInfo_Set_area().

set_last_merge_level()

void meshlib::WatershedGraph_BasinInfo::set_last_merge_level

(

value:f32

)

< water level in the basin when it was formed (by merge or creation) Modifies a member variable of class MR::WatershedGraph::BasinInfo named lastMergeLevel.

Calls MR_WatershedGraph_BasinInfo_Set_lastMergeLevel().

set_last_merge_volume()

void meshlib::WatershedGraph_BasinInfo::set_last_merge_volume

(

value:f32

)

< water volume in the basin when it was formed (by merge or creation) Modifies a member variable of class MR::WatershedGraph::BasinInfo named lastMergeVolume.

Calls MR_WatershedGraph_BasinInfo_Set_lastMergeVolume().

set_last_update_amount()

void meshlib::WatershedGraph_BasinInfo::set_last_update_amount

(

value:f32

)

< the amount when accVolume was last updated Modifies a member variable of class MR::WatershedGraph::BasinInfo named lastUpdateAmount.

Calls MR_WatershedGraph_BasinInfo_Set_lastUpdateAmount().

set_lowest_bd_level()

void meshlib::WatershedGraph_BasinInfo::set_lowest_bd_level

(

value:f32

)

< lowest position on the boundary of the basin Modifies a member variable of class MR::WatershedGraph::BasinInfo named lowestBdLevel.

Calls MR_WatershedGraph_BasinInfo_Set_lowestBdLevel().

set_lowest_level()

void meshlib::WatershedGraph_BasinInfo::set_lowest_level

(

value:f32

)

< lowest level (z-coordinate of lowestVert) in the basin Modifies a member variable of class MR::WatershedGraph::BasinInfo named lowestLevel.

Calls MR_WatershedGraph_BasinInfo_Set_lowestLevel().

set_lowest_vert()

void meshlib::WatershedGraph_BasinInfo::set_lowest_vert

(

value:meshlib::VertId

)

< in the whole basin Modifies a member variable of class MR::WatershedGraph::BasinInfo named lowestVert.

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

set_max_volume()

void meshlib::WatershedGraph_BasinInfo::set_max_volume

(

value:f32

)

< full water volume to be accumulated in the basin till water reaches the lowest height on the boundary Modifies a member variable of class MR::WatershedGraph::BasinInfo named maxVolume.

Calls MR_WatershedGraph_BasinInfo_Set_maxVolume().

set_overflow_via()

void meshlib::WatershedGraph_BasinInfo::set_overflow_via

(

value:meshlib::GraphEdgeId

)

< when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary Modifies a member variable of class MR::WatershedGraph::BasinInfo named overflowVia.

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

update_acc_volume()

void meshlib::WatershedGraph_BasinInfo::update_acc_volume

(

amount:f32

)

updates accumulated volume in the basin to the moment of given precipitation amount Generated from method MR::WatershedGraph::BasinInfo::updateAccVolume.

Calls MR_WatershedGraph_BasinInfo_updateAccVolume().

---

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

• MRWatershedGraph.rs