Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
migration::MigratorStatus Class Reference

The status of a migrator, it provides the helper functions to convert the status to string and vice versa. More...

#include <MigratiorStatus.hpp>

Public Types

enum  Status { Migrated , NotMigrated , NotKnown , NumStatuses }
 The status of a migrator.
 

Public Member Functions

 MigratorStatus (Status status)
 Construct a new Migrator Status object with the given status.
 
bool operator== (MigratorStatus const &other) const
 Compare the status with another MigratorStatus.
 
bool operator== (Status const &other) const
 Compare the status with another status.
 
std::string toString () const
 Convert the status to string.
 

Static Public Member Functions

static MigratorStatus fromString (std::string const &statusStr)
 Convert the string to status.
 

Detailed Description

The status of a migrator, it provides the helper functions to convert the status to string and vice versa.

Constructor & Destructor Documentation

◆ MigratorStatus()

migration::MigratorStatus::MigratorStatus ( Status status)
inline

Construct a new Migrator Status object with the given status.

Parameters
statusThe status of the migrator

Member Function Documentation

◆ fromString()

MigratorStatus migration::MigratorStatus::fromString ( std::string const & statusStr)
static

Convert the string to status.

Parameters
statusStrThe string to convert
Returns
The status representation of the string

◆ operator==() [1/2]

bool migration::MigratorStatus::operator== ( MigratorStatus const & other) const

Compare the status with another MigratorStatus.

Parameters
otherThe other status to compare
Returns
true if the status is equal to the other status, false otherwise

◆ operator==() [2/2]

bool migration::MigratorStatus::operator== ( Status const & other) const

Compare the status with another status.

Parameters
otherThe other status to compare
Returns
true if the status is equal to the other status, false otherwise

◆ toString()

std::string migration::MigratorStatus::toString ( ) const

Convert the status to string.

Returns
The string representation of the status

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