MJSO Class Reference

#include <mjsonrpc.h>

Inheritance diagram for MJSO:

Collaboration diagram for MJSO:

Public Member Functions
void	D (const char *description)
MJSO *	Params ()
MJSO *	Result ()
MJSO *	PA (const char *description)
MJSO *	RA (const char *description)
void	P (const char *name, int mjson_type, const char *description)
void	R (const char *name, int mjson_type, const char *description)
void	Add (const char *name, int mjson_type, const char *description)
MJSO *	AddObject (const char *name, const char *description)
MJSO *	AddArray (const char *name, const char *description)

Static Public Member Functions
static MJSO *	I ()

Protected Member Functions
void	AddToSchema (MJsonNode *s, const char *name)
	MJSO ()

Static Protected Member Functions
static MJSO *	MakeObjectSchema (const char *description)
static MJSO *	MakeArraySchema (const char *description)

Protected Attributes
MJsonNode *	properties
MJsonNode *	required
MJsonNode *	items
MJSO *	params
MJSO *	result

Detailed Description

MIDAS JSON Schema Objects for documenting RPC calls.

Typical use:

static MJsonNode* js_cm_exist(const MJsonNode* params) { if (!params) { MJSO* doc = MJSO::I(); doc->D("calls MIDAS cm_exist() to check if given MIDAS program is running"); doc->P("name", MJSON_STRING, "name of the program, corresponding to ODB /Programs/name"); doc->P("unique?", MJSON_BOOL, "bUnique argument to cm_exist()"); doc->R("status", MJSON_INT, "return status of cm_exist()"); return doc; } ... rpc function body }

Definition at line 58 of file mjsonrpc.h.

---

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

• include/mjsonrpc.h
• src/mjsonrpc.cxx