Arc::JobState Class Reference

#include <arc/compute/JobState.h>

Inheritance diagram for Arc::JobState:

Public Member Functions
bool	IsFinished () const
	Check if state is finished. More...
const std::string &	operator() () const
	Unformatted specific job state. More...
const std::string &	GetGeneralState () const
	General string representation of job state. More...
std::string	GetSpecificState () const
	Specific string representation of job state. More...

Detailed Description

ARC general state model. The class comprise the general state model of the ARC-lib, and are herein used to compare job states from the different middlewares supported by the plugin structure of the ARC-lib. Which is why every ACC plugin should contain a class derived from this class. The derived class should consist of a constructor and a mapping function (a JobStateMap) which maps a std::string to a JobState:StateType. An example of a constructor in a plugin could be: JobStatePlugin::JobStatePluging(const std::string& state) : JobState(state, &pluginStateMap) {} where &pluginStateMap is a reference to the JobStateMap defined by the derived class.

Member Function Documentation

const std::string& Arc::JobState::GetGeneralState ( ) const

inline

General string representation of job state.

Get the string representation of the job state as mapped to the libarccompute job state model.

Returns

string representing general job state

See Also

enum StateType

GetSpecificState

std::string Arc::JobState::GetSpecificState ( ) const

inline

Specific string representation of job state.

Get the string representation of the job state as returned by the CE service possibly formatted to a human readable string.

Returns

string representing specific, possibly formatted, job state

See Also

GetGeneralState

operator()

bool Arc::JobState::IsFinished ( ) const

inline

Check if state is finished.

Returns

true is returned if the StateType is equal to FINISHED, KILLED, FAILED or DELETED, otherwise false is returned.

const std::string& Arc::JobState::operator() ( ) const

inline

Unformatted specific job state.

Get the unformatted specific job state as returned by the CE.

Returns

job state as returned by CE

See Also

GetSpecificState

GetGeneralState

---

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

• JobState.h