Pomerol::ComputableObject Struct Reference

A base class for computable objects. More...

#include <ComputableObject.hpp>

Inheritance diagram for Pomerol::ComputableObject:

Data Structures
class	StatusMismatch
	Exception: Unexpected computation status of a computable object. More...

Public Types
enum	StatusEnum { Constructed, Prepared, Computed }
	Computation status of the object. More...

Public Member Functions
	ComputableObject ()=default
StatusEnum	getStatus () const
	Return the current computation status. More...
void	setStatus (StatusEnum Status_in)

Protected Attributes
StatusEnum	Status = Constructed
	Current computation status. More...

Detailed Description

A base class for computable objects.

Definition at line 28 of file ComputableObject.hpp.

Member Enumeration Documentation

StatusEnum

enum Pomerol::ComputableObject::StatusEnum

Computation status of the object.

Enumerator
Constructed	Object has been constructed.
Prepared	Object has been prepared for computation (usually means memory allocation).
Computed	Object has been computed.

Definition at line 31 of file ComputableObject.hpp.

Constructor & Destructor Documentation

ComputableObject()

Pomerol::ComputableObject::ComputableObject ( )

default

Member Function Documentation

getStatus()

StatusEnum Pomerol::ComputableObject::getStatus ( ) const

inline

Return the current computation status.

Definition at line 45 of file ComputableObject.hpp.

setStatus()

void Pomerol::ComputableObject::setStatus ( StatusEnum  Status_in )

inline

Set the computation status.

Parameters

[in]

Status_in

New computation status.

Definition at line 48 of file ComputableObject.hpp.

Field Documentation

Status

StatusEnum Pomerol::ComputableObject::Status = Constructed

protected

Current computation status.

Definition at line 39 of file ComputableObject.hpp.

---

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

• pomerol/ComputableObject.hpp