ARC SDK
Public Types | Public Member Functions | Static Public Member Functions
Arc::EndpointSubmissionStatus Class Reference

Public Types

enum  EndpointSubmissionStatusType { UNKNOWN, NOPLUGIN, SUCCESSFUL }
 

Public Member Functions

 EndpointSubmissionStatus (EndpointSubmissionStatusType status=UNKNOWN, const std::string &description="")
 
bool operator== (EndpointSubmissionStatusType s) const
 
bool operator== (const EndpointSubmissionStatus &s) const
 
bool operator!= (EndpointSubmissionStatusType s) const
 
bool operator!= (const EndpointSubmissionStatus &s) const
 
bool operator! () const
 
 operator bool () const
 
EndpointSubmissionStatusoperator= (EndpointSubmissionStatusType s)
 
EndpointSubmissionStatusoperator= (const EndpointSubmissionStatus &s)
 
EndpointSubmissionStatusType getStatus () const
 
const std::string & getDescription () const
 
std::string str () const
 

Static Public Member Functions

static std::string str (EndpointSubmissionStatusType status)
 

Member Enumeration Documentation

◆ EndpointSubmissionStatusType

The possible states:

Constructor & Destructor Documentation

◆ EndpointSubmissionStatus()

Arc::EndpointSubmissionStatus::EndpointSubmissionStatus ( EndpointSubmissionStatusType  status = UNKNOWN,
const std::string &  description = "" 
)
inline

A new EndpointSubmissionStatus is created with UNKNOWN status and with an empty description by default

Member Function Documentation

◆ getDescription()

const std::string& Arc::EndpointSubmissionStatus::getDescription ( ) const
inline

Return the description string contained within this EndpointSubmissionStatus object

◆ getStatus()

EndpointSubmissionStatusType Arc::EndpointSubmissionStatus::getStatus ( ) const
inline

Return the enum EndpointSubmissionStatusType contained within this EndpointSubmissionStatus object

◆ operator bool()

Arc::EndpointSubmissionStatus::operator bool ( ) const
inline
Returns
true if the status is successful

◆ operator!()

bool Arc::EndpointSubmissionStatus::operator! ( void  ) const
inline
Returns
true if the status is not successful

◆ operator!=() [1/2]

Inequality.

See also
operator==(EndpointSubmissionStatus)

◆ operator!=() [2/2]

Inequality.

See also
operator==(const EndpointSubmissionStatus&)

◆ operator=() [1/2]

EndpointSubmissionStatus& Arc::EndpointSubmissionStatus::operator= ( EndpointSubmissionStatusType  s)
inline

Setting the EndpointSubmissionStatus object's state

Parameters
[in]sthe new enum EndpointSubmissionStatusType status

◆ operator=() [2/2]

EndpointSubmissionStatus& Arc::EndpointSubmissionStatus::operator= ( const EndpointSubmissionStatus s)
inline

Copying the EndpointSubmissionStatus object into this one.

Parameters
[in]sthe EndpointSubmissionStatus object whose status and description will be copied into this object

◆ operator==() [1/2]

bool Arc::EndpointSubmissionStatus::operator== ( EndpointSubmissionStatusType  s) const
inline

This EndpointSubmissionStatus object equals to an enum EndpointSubmissionStatusType if it contains the same state

◆ operator==() [2/2]

bool Arc::EndpointSubmissionStatus::operator== ( const EndpointSubmissionStatus s) const
inline

This EndpointSubmissionStatus object equals to another EndpointQueryingStatus object, if their state equals. The description doesn't matter.

◆ str() [1/2]

static std::string Arc::EndpointSubmissionStatus::str ( EndpointSubmissionStatusType  status)
static

String representation of the states in the enum EndpointSubmissionStatusType

◆ str() [2/2]

std::string Arc::EndpointSubmissionStatus::str ( void  ) const
inline

String representation of the EndpointSubmissionStatus object, which is currently simply the string representation of the enum EndpointSubmissionStatusType


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