WPSStatus: WPSStatus

In ows4R: Interface to OGC Web-Services (OWS)

WPSStatus

Description

WPSStatus

WPSStatus

Format

R6Class object.

Value

Object of R6Class for modelling a WPS Status

Super class

ows4R::OGCAbstractObject -> WPSStatus

Public fields

value

status value

percentCompleted

status percentage of completion

Methods

Public methods

• WPSStatus$new()

• WPSStatus$decode()

• WPSStatus$getValue()

• WPSStatus$getPercentCompleted()

• WPSStatus$getCreationTime()

• WPSStatus$clone()

Inherited methods

• ows4R::OGCAbstractObject$ERROR()
• ows4R::OGCAbstractObject$INFO()
• ows4R::OGCAbstractObject$WARN()
• ows4R::OGCAbstractObject$encode()
• ows4R::OGCAbstractObject$getClass()
• ows4R::OGCAbstractObject$getClassName()
• ows4R::OGCAbstractObject$getNamespaceDefinition()
• ows4R::OGCAbstractObject$isFieldInheritedFrom()
• ows4R::OGCAbstractObject$logger()

---

Method new()

Initalizes a WPSStatus object

Usage

WPSStatus$new(xml = NULL, serviceVersion = "1.0.0")

Arguments

xml

an object of class XMLInternalNode-class from XML

serviceVersion

WPS service version. Default is "1.0.0"

---

Method decode()

Decodes WPS status from XML

Usage

WPSStatus$decode(xml)

Arguments

xml

an object of class XMLInternalNode-class from XML

---

Method getValue()

Get status value, among accepted WPS status values defined in the WPS standard: ProcessAccepted, ProcessStarted, ProcessPaused, ProcessSucceeded, ProcessFailed.

Usage

WPSStatus$getValue()

Returns

value, object of class character

---

Method getPercentCompleted()

Get percentage of completion

Usage

WPSStatus$getPercentCompleted()

Returns

the percentage of completion, object of class integer

---

Method getCreationTime()

Get creation time

Usage

WPSStatus$getCreationTime()

Returns

the creation time, object of class POSIXct

---

Method clone()

The objects of this class are cloneable with this method.

Usage

WPSStatus$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <[e-mail]>

ows4R documentation built on Sept. 1, 2023, 5:09 p.m.