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

Represents the status in the EntityRetriever of the query process of an Endpoint (service registry, computing element). More...

#include <arc/compute/EndpointQueryingStatus.h>

Public Types

enum  EndpointQueryingStatusType {
  UNKNOWN, SUSPENDED_NOTREQUIRED, STARTED, FAILED,
  NOPLUGIN, NOINFORETURNED, SUCCESSFUL
}
 

Public Member Functions

 EndpointQueryingStatus (EndpointQueryingStatusType status=UNKNOWN, const std::string &description="")
 
bool operator== (EndpointQueryingStatusType s) const
 
bool operator== (const EndpointQueryingStatus &s) const
 
bool operator!= (EndpointQueryingStatusType s) const
 
bool operator!= (const EndpointQueryingStatus &s) const
 
bool operator! () const
 
 operator bool () const
 
EndpointQueryingStatusoperator= (EndpointQueryingStatusType s)
 
EndpointQueryingStatusoperator= (const EndpointQueryingStatus &s)
 
EndpointQueryingStatusType getStatus () const
 
const std::string & getDescription () const
 
std::string str () const
 

Static Public Member Functions

static std::string str (EndpointQueryingStatusType status)
 

Friends

bool operator== (EndpointQueryingStatusType, const EndpointQueryingStatus &)
 

Detailed Description

Represents the status in the EntityRetriever of the query process of an Endpoint (service registry, computing element).

An object of this class is returned by the instances of the EntityRetriever (e.g. ServiceEndpointRetriever, TargetInformationRetriever, JobListRetriever) representing the state of the process of querying an Endpoint. It contains an EndpointQueryingStatusType enum (getStatus), and a description string (getDescription)

Member Enumeration Documentation

◆ EndpointQueryingStatusType

The possible states:

Enumerator
UNKNOWN 

the state is unknown

SUSPENDED_NOTREQUIRED 

Querying of the endpoint is suspended since querying it is not required.

STARTED 

the query process was started

FAILED 

the query process failed

NOPLUGIN 

there is no plugin for the given Endpoint InterfaceName (so the query process was not even started)

NOINFORETURNED 

query was successful but the response didn't contain entity information

SUCCESSFUL 

the query process was successful

Constructor & Destructor Documentation

◆ EndpointQueryingStatus()

Arc::EndpointQueryingStatus::EndpointQueryingStatus ( EndpointQueryingStatusType  status = UNKNOWN,
const std::string &  description = "" 
)
inline

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

Member Function Documentation

◆ getDescription()

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

Return the description string contained within this EndpointQueryingStatus object

◆ getStatus()

EndpointQueryingStatusType Arc::EndpointQueryingStatus::getStatus ( ) const
inline

Return the enum EndpointQueryingStatusType contained within this EndpointQueryingStatus object

◆ operator bool()

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

◆ operator!()

bool Arc::EndpointQueryingStatus::operator! ( void  ) const
inline
Returns
true if the status is not successful
Python interface deviation
Method is unavailable in Python interface

◆ operator!=() [1/2]

Inequality.

See also
operator==(EndpointQueryingStatusType)

◆ operator!=() [2/2]

Inequality.

See also
operator==(const EndpointQueryingStatus&)

◆ operator=() [1/2]

EndpointQueryingStatus& Arc::EndpointQueryingStatus::operator= ( EndpointQueryingStatusType  s)
inline

Setting the EndpointQueryingStatus object's state

Parameters
[in]sthe new enum EndpointQueryingStatusType status
Python interface deviation
Method is unavailable in Python interface

◆ operator=() [2/2]

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

Copying the EndpointQueryingStatus object into this one.

Parameters
[in]sthe EndpointQueryingStatus object whose status and description will be copied into this object
Python interface deviation
Method is unavailable in Python interface

◆ operator==() [1/2]

bool Arc::EndpointQueryingStatus::operator== ( EndpointQueryingStatusType  s) const
inline

This EndpointQueryingStatus object equals to an enum EndpointQueryingStatusType if it contains the same state

◆ operator==() [2/2]

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

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

◆ str() [1/2]

static std::string Arc::EndpointQueryingStatus::str ( EndpointQueryingStatusType  status)
static

String representation of the states in the enum EndpointQueryingStatusType

◆ str() [2/2]

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

String representation of the EndpointQueryingStatus object, which is currently simply the string representation of the enum EndpointQueryingStatusType


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