hy_features::hydrolocation::HY_HydroLocation Class Reference

#include <HY_HydroLocation.hpp>

Inheritance diagram for hy_features::hydrolocation::HY_HydroLocation:

Collaboration diagram for hy_features::hydrolocation::HY_HydroLocation:

Public Member Functions
	HY_HydroLocation (point_t shape, HY_HydroLocationType input_type, HY_IndirectPosition referenced_position)
	Constructor for when the attached nexus is not known.
	HY_HydroLocation (point_t shape, HY_HydroLocationType input_type, HY_IndirectPosition referenced_position, Nexus nexus)
	Constructor for when attached nexus is known.
point_t &	geometry ()
	get the shape of the location
const point_t &	geometry () const
HY_HydroLocationType &	itype ()
	get the type if the location
const HY_HydroLocationType &	itype () const
HY_IndirectPosition &	referenced_position ()
	get the central point for the location
const HY_IndirectPosition &	referenced_position () const
Nexus &	realized_nexus ()
	get the attached nexus for this location
const Nexus &	realized_nexus () const

Private Types
using	Nexus = std::string

Private Attributes
point_t	_shape
	shape for location
HY_HydroLocationType	_type
	type for location
HY_IndirectPosition	_referenced_position
	reference position for location
Nexus	_realized_nexus
	nexus connected to this location

Member Typedef Documentation

Nexus

using hy_features::hydrolocation::HY_HydroLocation::Nexus = std::string

private

Constructor & Destructor Documentation

HY_HydroLocation() [1/2]

hy_features::hydrolocation::HY_HydroLocation::HY_HydroLocation ( point_t shape, HY_HydroLocationType input_type, HY_IndirectPosition referenced_position )

inline

Constructor for when the attached nexus is not known.

HY_HydroLocation() [2/2]

hy_features::hydrolocation::HY_HydroLocation::HY_HydroLocation ( point_t shape, HY_HydroLocationType input_type, HY_IndirectPosition referenced_position, Nexus nexus )

inline

Constructor for when attached nexus is known.

Member Function Documentation

geometry() [1/2]

point_t & hy_features::hydrolocation::HY_HydroLocation::geometry ( )

inline

get the shape of the location

References _shape.

geometry() [2/2]

const point_t & hy_features::hydrolocation::HY_HydroLocation::geometry ( ) const

inline

References _shape.

itype() [1/2]

HY_HydroLocationType & hy_features::hydrolocation::HY_HydroLocation::itype ( )

inline

get the type if the location

References _type.

itype() [2/2]

const HY_HydroLocationType & hy_features::hydrolocation::HY_HydroLocation::itype ( ) const

inline

References _type.

realized_nexus() [1/2]

Nexus & hy_features::hydrolocation::HY_HydroLocation::realized_nexus ( )

inline

get the attached nexus for this location

References _realized_nexus.

realized_nexus() [2/2]

const Nexus & hy_features::hydrolocation::HY_HydroLocation::realized_nexus ( ) const

inline

References _realized_nexus.

referenced_position() [1/2]

HY_IndirectPosition & hy_features::hydrolocation::HY_HydroLocation::referenced_position ( )

inline

get the central point for the location

References _referenced_position.

referenced_position() [2/2]

const HY_IndirectPosition & hy_features::hydrolocation::HY_HydroLocation::referenced_position ( ) const

inline

References _referenced_position.

Member Data Documentation

_realized_nexus

Nexus hy_features::hydrolocation::HY_HydroLocation::_realized_nexus

private

nexus connected to this location

Referenced by realized_nexus(), and realized_nexus().

_referenced_position

HY_IndirectPosition hy_features::hydrolocation::HY_HydroLocation::_referenced_position

private

reference position for location

Referenced by referenced_position(), and referenced_position().

_shape

point_t hy_features::hydrolocation::HY_HydroLocation::_shape

private

shape for location

Referenced by geometry(), and geometry().

_type

HY_HydroLocationType hy_features::hydrolocation::HY_HydroLocation::_type

private

type for location

Referenced by itype(), and itype().

---

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

• include/core/hydrolocation/HY_HydroLocation.hpp