phaser-server  0.0.2
Public Member Functions | Protected Member Functions | List of all members
JobStateNotice Class Reference

Notify the state of the RF phasing job. More...

#include <notify.h>

Inheritance diagram for JobStateNotice:
Inheritance graph
[legend]
Collaboration diagram for JobStateNotice:
Collaboration graph
[legend]

Public Member Functions

 JobStateNotice (const PhaseJob *job)
 
- Public Member Functions inherited from JsonNotice
 JsonNotice (const char *value)
 Initialize the value of the 'notification' tag.
 
std::string operator() (void)
 Get the JSON encoded response string.
 

Protected Member Functions

virtual void Create (JSONObject &) override
 Add job state information. More...
 
- Protected Member Functions inherited from JobNotice
 JobNotice (const char *value, const PhaseJob *job)
 Initialize value of 'notification' tag and the RF phasing job.
 
void AddDate (JSONObject &, const char *, time_t)
 Add date information to the passed JSON object. More...
 

Additional Inherited Members

- Protected Attributes inherited from JobNotice
const PhaseJobm_job
 Job whose status is to be reported.
 

Detailed Description

Notify the state of the RF phasing job.

Note
A copy of the passed job is not made, it must stay in scope and have a consistent state for the lifetime of the object.

Constructor & Destructor Documentation

◆ JobStateNotice()

JobStateNotice::JobStateNotice ( const PhaseJob job)
inline

Construct an instance.

Parameters
job- The currently executing job.

Member Function Documentation

◆ Create()

void JobStateNotice::Create ( JSONObject &  root)
overrideprotectedvirtual

Add job state information.

If there is no job, a simple null JSON values is inserted as the "job" tag with no other tags present.

Parameters
root- JSON object to be updated.

Implements JsonNotice.


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