autopas::DeleteParticleResult Struct Reference

Temporary deprecation helper struct. More...

#include <AutoPasDecl.h>

Public Member Functions
	operator bool () const
	Conversion to the bool that AutoPas::deleteParticle(Particle_T &particle) used to return.

Detailed Description

Temporary deprecation helper struct.

AutoPas::deleteParticle(Particle_T &particle) used to return a bool. As deleting a particle now only marks it as deleted, this bool is always false and thus redundant so we want to move it to a void function. As the return type is not part of the function signature, we cannot have a new void deleteParticle alongside a deprecated bool deleteParticle. So instead, we return this struct which will implicitly convert to bool with a deprecation warning, but will be treated silently where the return struct is not used.

Note

This type will be removed in AutoPas v3, when AutoPas::deleteParticle(Particle_T &particle) returns void.

Member Function Documentation

operator bool()

autopas::DeleteParticleResult::operator bool ( ) const

inline

Conversion to the bool that AutoPas::deleteParticle(Particle_T &particle) used to return.

Returns

Always false.

---

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

• autopas/AutoPasDecl.h