Opm::Action::Result::MatchingEntities Class Reference

Container of matching entities. More...

#include <ActionResult.hpp>

Classes
class	Impl
	Implementation of Result::MatchingEntities. More...

Public Member Functions
	MatchingEntities ()
	Default constructor. More...
	MatchingEntities (const MatchingEntities &rhs)
	Copy constructor. More...
	MatchingEntities (MatchingEntities &&rhs)
	Move constructor. More...
	~MatchingEntities ()
	Destructor. More...
bool	operator== (const MatchingEntities &that) const
	Assignment operator. More...

Friends
class	Result

Detailed Description

Container of matching entities.

These are entities–typically wells or groups–for which an ACTIONX condition (or sub-condition) holds.

Constructor & Destructor Documentation

MatchingEntities() [1/3]

Opm::Action::Result::MatchingEntities::MatchingEntities

(

)

Default constructor.

Forms an empty set of matching entities. Expected to be called by class Result only.

MatchingEntities() [2/3]

Opm::Action::Result::MatchingEntities::MatchingEntities

(

const MatchingEntities &

rhs

)

Copy constructor.

Parameters

[in]

rhs

Source object from which to form an independent copy.

MatchingEntities() [3/3]

Opm::Action::Result::MatchingEntities::MatchingEntities

(

MatchingEntities &&

rhs

)

Move constructor.

Parameters

[in,out]

rhs

Source object from which form a new object. Left in an empty state on return from the move constructor.

~MatchingEntities()

Opm::Action::Result::MatchingEntities::~MatchingEntities ( )

default

Destructor.

Needed for PIMPL idiom.

Member Function Documentation

operator==()

bool Opm::Action::Result::MatchingEntities::operator==

(

const MatchingEntities &

that

)

const

Assignment operator.

Parameters

[in]

that

Source object whose value will overwrite *this. \return *this. MatchingEntities& operator=(const MatchingEntities& that); Move-assignment operator. \param[in] rhs Source object which will be moved into \code *this. Left in an empty state on return from the move constructor. \return *this. MatchingEntities& operator=(MatchingEntities&& rhs); Get sequence of read-only well names for which the current Result's conditionSatisfied() member function returns true. ValueRange<std::string> wells() const; Whether or not named well is in the list of matching entities. \param[in] well Well name. \return Whether or not \p well is among the matching wells. bool hasWell(const std::string& well) const; Equality predicate. \param[in] that Object against which \code *this will be tested for equality.

Returns

Whether or not

*this 

is the same as that.

---

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

• opm/input/eclipse/Schedule/Action/ActionResult.hpp
• opm/input/eclipse/Schedule/Action/ActionResult.cpp