PolymarkerServiceJob Struct Reference

A datatype for storing a ServiceJob for the PolymarkerService with its extra associated fields. More...

#include <polymarker_service_job.h>

Collaboration diagram for PolymarkerServiceJob:

Public Member Functions
void	FreePolymarkerServiceJob (ServiceJob *job_p)
	Free the PolymarkerServiceJob. More...
bool	UpdatePolymarkerServiceJob (ServiceJob *job_p)
	Update the running status of PolymarkerServiceJob if needed. More...
ServiceJob *	GetPolymarkerServiceJobFromJSON (struct Service *service_p, const json_t *service_job_json_p)
	Create a PolymarkerServiceJob from a JSON-based serialisation. More...
json_t *	ConvertPolymarkerServiceJobToJSON (Service *service_p, ServiceJob *service_job_p, bool omit_results_flag)
	Get the JSON representation of a PolymarkerServiceJob. More...

Data Fields
ServiceJob	psj_base_job
	The base ServiceJob. More...
PolymarkerTool *	psj_tool_p
	The PolymarkerTool used for this PolymarkerServiceJob. More...

Detailed Description

A datatype for storing a ServiceJob for the PolymarkerService with its extra associated fields.

Member Function Documentation

FreePolymarkerServiceJob()

void FreePolymarkerServiceJob

(

ServiceJob *

job_p

)

Free the PolymarkerServiceJob.

Parameters

job_p

The PolymarkerServiceJob to free.

UpdatePolymarkerServiceJob()

bool UpdatePolymarkerServiceJob

(

ServiceJob *

job_p

)

Update the running status of PolymarkerServiceJob if needed.

Parameters

job_p

The PolymarkerServiceJob to check.

Returns

true if the PolymarkerServiceJob was updated successfully, false otherwise.

GetPolymarkerServiceJobFromJSON()

ServiceJob * GetPolymarkerServiceJobFromJSON	(	struct Service *	service_p,
		const json_t *	service_job_json_p
	)

Create a PolymarkerServiceJob from a JSON-based serialisation.

Parameters

service_p	The type of Blast Service that previously created the BlastServiceJob.
service_job_json_p	The JSON fragment representing the PolymarkerServiceJob.

Returns

The PolymarkerServiceJob or NULL upon error.

ConvertPolymarkerServiceJobToJSON()

json_t * ConvertPolymarkerServiceJobToJSON	(	Service *	service_p,
		ServiceJob *	service_job_p,
		bool	omit_results_flag
	)

Get the JSON representation of a PolymarkerServiceJob.

Parameters

service_p	The Service that ran the PolymarkerServiceJob.
service_job_p	The PolymarkerServiceJob to serialise.

Returns

The JSON fragment representing the PolymarkerServiceJob or NULL upon error.

Field Documentation

psj_base_job

ServiceJob psj_base_job

The base ServiceJob.

psj_tool_p

PolymarkerTool* psj_tool_p

The PolymarkerTool used for this PolymarkerServiceJob.

---

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

• polymarker_service_job.h