rms Namespace Reference

Classes
class	article
class	condition
class	content_page
class	experiment
class	javascript_file
class	rms_client
	Provides direct communication to the RMS API to via cURL. More...
struct	rms_response
class	slide
class	study
class	study_log
class	user_account
Enumerations
enum	PROTOCOL { HTTP_PROTOCOL, HTTPS_PROTOCOL }
enum	USER_ACCOUNT_TYPE { ADMIN, USER }
Functions
size_t	write_data (char *ptr, size_t size, size_t nmemb, rms::rms_response *buf)
Variables
const std::string	API = "/api/"
const std::string	ARTICLES_DEFAULT = "content/articles/"
const std::string	ARTICLES_ID_FIELD = "id"
const std::string	ARTICLES_PAGES_ID_FIELD = "pageid"
const std::string	CONDITIONS_DEFAULT = "user_studies/conditions/"
const std::string	CONDITIONS_ID_FIELD = "id"
const std::string	CONTENT_PAGES_DEFAULT = "content/content_pages/"
const std::string	CONTENT_PAGES_ID_FIELD = "id"
const std::string	EXPERIMENTS_DEFAULT = "user_studies/experiments/"
const std::string	EXPERIMENTS_ID_FIELD = "id"
const std::string	JAVASCRIPT_FILES_DEFAULT = "config/javascript_files/"
const std::string	JAVASCRIPT_FILES_ID_FIELD = "id"
const std::string	SLIDES_DEFAULT = "content/slides/"
const std::string	STUDIES_DEFAULT = "user_studies/studies/"
const std::string	STUDIES_ID_FIELD = "id"
const std::string	STUDY_LOGS_DEFAULT = "user_studies/study_logs/"
const std::string	STUDY_LOGS_EXPERIMENTS_ID_FIELD = "expid"
const std::string	STUDY_LOGS_ID_FIELD = "id"
const std::string	USER_ACCOUNTS_DEFAULT = "users/user_accounts/"
const std::string	USER_ACCOUNTS_ID_FIELD = "id"

---

Detailed Description

rms namespace for all RMS calls and objects

---

Enumeration Type Documentation

enum rms::PROTOCOL

The different communication protocols that can be used with the RMS API.

Enumerator:

HTTP_PROTOCOL
HTTPS_PROTOCOL

Definition at line 38 of file rms.h.

enum rms::USER_ACCOUNT_TYPE

The different types of users in the RMS.

Enumerator:

ADMIN
USER

Definition at line 26 of file user_account.h.

---

Function Documentation

size_t rms::write_data	(	char *	ptr,
		size_t	size,
		size_t	nmemb,
		rms::rms_response *	buf
	)

The callback function used by cURL to store the response from the Rovio. This function should only be used by cURL internally by the rms_client.

Parameters:

ptr	the pointer to the data
size	size * nmemb is the exact size of the data
nmemb	size * nmemb is the exact size of the data
buf	the buffer to put the data into

Definition at line 754 of file rms.cpp.

---

Variable Documentation

const std::string rms::API = "/api/"

default script in the RMS API

Definition at line 43 of file rms.h.

const std::string rms::ARTICLES_DEFAULT = "content/articles/"

default articles script in the RMS API

Definition at line 48 of file rms.h.

const std::string rms::ARTICLES_ID_FIELD = "id"

article id field in the articles script in the RMS API

Definition at line 49 of file rms.h.

const std::string rms::ARTICLES_PAGES_ID_FIELD = "pageid"

page id field in the articles script in the RMS API

Definition at line 50 of file rms.h.

const std::string rms::CONDITIONS_DEFAULT = "user_studies/conditions/"

default conditions script in the RMS API

Definition at line 57 of file rms.h.

const std::string rms::CONDITIONS_ID_FIELD = "id"

condition id field in the conditions script in the RMS API

Definition at line 58 of file rms.h.

const std::string rms::CONTENT_PAGES_DEFAULT = "content/content_pages/"

default content pages script in the RMS API

Definition at line 52 of file rms.h.

const std::string rms::CONTENT_PAGES_ID_FIELD = "id"

content pages id field in the content pages script in the RMS API

Definition at line 53 of file rms.h.

const std::string rms::EXPERIMENTS_DEFAULT = "user_studies/experiments/"

default experiments script in the RMS API

Definition at line 60 of file rms.h.

const std::string rms::EXPERIMENTS_ID_FIELD = "id"

experiment id field in the experiments script in the RMS API

Definition at line 61 of file rms.h.

const std::string rms::JAVASCRIPT_FILES_DEFAULT = "config/javascript_files/"

default Javascript files script in the RMS API

Definition at line 45 of file rms.h.

const std::string rms::JAVASCRIPT_FILES_ID_FIELD = "id"

Javascript file id field in the Javascript files script in the RMS API

Definition at line 46 of file rms.h.

const std::string rms::SLIDES_DEFAULT = "content/slides/"

default slides script in the RMS API

Definition at line 55 of file rms.h.

const std::string rms::STUDIES_DEFAULT = "user_studies/studies/"

default studies script in the RMS API

Definition at line 63 of file rms.h.

const std::string rms::STUDIES_ID_FIELD = "id"

study id field in the studies script in the RMS API

Definition at line 64 of file rms.h.

const std::string rms::STUDY_LOGS_DEFAULT = "user_studies/study_logs/"

default study logs script in the RMS API

Definition at line 66 of file rms.h.

const std::string rms::STUDY_LOGS_EXPERIMENTS_ID_FIELD = "expid"

experiment id field in the study logs script in the RMS API

Definition at line 68 of file rms.h.

const std::string rms::STUDY_LOGS_ID_FIELD = "id"

study log id field in the study logs script in the RMS API

Definition at line 67 of file rms.h.

const std::string rms::USER_ACCOUNTS_DEFAULT = "users/user_accounts/"

default user_accounts script in the RMS API

Definition at line 70 of file rms.h.

const std::string rms::USER_ACCOUNTS_ID_FIELD = "id"

user account id field in the user_accounts script in the RMS API

Definition at line 71 of file rms.h.