FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Spatial::FMTEventRelation Class Reference

Relation between two spatial events, holding the from and to action, period and coordinate of the closest points. More...

#include <FMTEventRelation.h>

Public Member Functions

 FMTEventRelation (const Spatial::FMTEvent &fromevent, const Spatial::FMTEvent &toevent)
 Construct a FMTEventRelation from two events.
 
bool operator== (const FMTEventRelation &rhs) const
 Comparison operator for FMTEventRelation.
 
size_t hash () const
 Hash the event relation.
 
 FMTEventRelation (const FMTEventRelation &rhs)=default
 Copy constructor for FMTEventRelation.
 
FMTEventRelationoperator= (const FMTEventRelation &rhs)=default
 Copy assignment operator for FMTEventRelation.
 
 ~FMTEventRelation ()=default
 Default destructor for FMTEventRelation.
 

Detailed Description

Relation between two spatial events, holding the from and to action, period and coordinate of the closest points.

Constructor & Destructor Documentation

◆ FMTEventRelation() [1/2]

Spatial::FMTEventRelation::FMTEventRelation ( const Spatial::FMTEvent fromevent,
const Spatial::FMTEvent toevent 
)

Construct a FMTEventRelation from two events.

Parameters
[in]fromeventthe from event.
[in]toeventthe to event.

◆ FMTEventRelation() [2/2]

Spatial::FMTEventRelation::FMTEventRelation ( const FMTEventRelation rhs)
default

Copy constructor for FMTEventRelation.

Parameters
[in]rhsthe FMTEventRelation to copy.

◆ ~FMTEventRelation()

Spatial::FMTEventRelation::~FMTEventRelation ( )
default

Default destructor for FMTEventRelation.

Member Function Documentation

◆ hash()

size_t Spatial::FMTEventRelation::hash ( ) const

Hash the event relation.

Returns
the hash of the relation.

◆ operator=()

FMTEventRelation & Spatial::FMTEventRelation::operator= ( const FMTEventRelation rhs)
default

Copy assignment operator for FMTEventRelation.

Parameters
[in]rhsthe FMTEventRelation to copy.
Returns
a reference to this FMTEventRelation.

◆ operator==()

bool Spatial::FMTEventRelation::operator== ( const FMTEventRelation rhs) const

Comparison operator for FMTEventRelation.

Parameters
[in]rhsthe FMTEventRelation to compare to.
Returns
true if both relations are equal else false.

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