Constants

APP_DIR

« More »

WEBROOT_DIR

« More »

WWW_ROOT

« More »

Classes, interfaces and traits

AppController

Main Application Controller

Add your application-wide methods in the class below, your controllers will inherit them. This is useful for setting global flags and menu variables for views. A global authorization function is also defined for all admin rights in RMS controllers.

« More »

AppHelper

Application Helper

Add your application-wide methods in the class below, your helpers will inherit them.

« More »

AppModel

Main Application Model

The application model base class contains useful functions and definitions for all models in the RMS.

« More »

Appointment

Appointment Model

Appointments represent a reserved user study session slot. It contains information about the associated user (if any) and slot.

« More »

AppointmentsController

Study Session Appointments Controller

A user study session appointments contains information about the associated user (if any) and slot.

« More »

AppShell

Application Shell

Add your application-wide methods in the class below, your shells will inherit them.

« More »

Article

Article Model

Articles are used to store content on a given page. They consist of a title and the associated content.

« More »

ArticlesController

Content Articles Controller

Content articles contain information that is displayed on a given page. Each page has a number of content articles.

« More »

BasicInterfaceController

Basic Interface Controller

The basic interface controller. This is a simple interface with a camera feed and keyboard teleoperation.

« More »

CarlDemoInterfaceController

CARL Demo Interface Controller

The CARL demo interface controller. This interface will allow for navigation and manipulation controls.

« More »

Collada

Colladas Model

Colladas define threejs Collada loaders. Currently, these models cannot be modified via the admin interface as they should remain constant for proper functionality.

« More »

Condition

Condition Model

Conditions represent a user study condition. It contains information about the name and associated interface.

« More »

ConditionsController

Study Conditions Controller

A user study condition contains information about the name of the condition and associated interface.

« More »

ContentController

Content Controller

The content controller has a single index action for the site content menu items.

« More »

CrowdManipulationInterfaceController

Crowd Manipulation Interface Controller

The Crowd Manipulation Interface controller. This interface will allow for navigation and manipulation controls.

« More »

DATABASE_CONFIG

« More »

Email

SMTP Email Settings Model

SMTP email settings contain information about email server settings.

« More »

EmailConfig

Email Settings Configuration

The email settings configuration will dynamically load settings from the RMS database.

« More »

EmailsController

Email Settings Controller

Email settings can be used to send automated emails from the RMS. This includes features like password resets and account creation emails.

« More »

Environment

Environments Model

Environments are linked to a rosbridge and MJPEG server. Each has a unique name.

« More »

EnvironmentsController

Robot Environments Controller

A robot environment consists of a rosbridge server and MJPEG server.

« More »

ExperimentController

Experiment Controller

The experiment controller has a single index action for the user study items.

« More »

GlobalController

Global Controller

The global settings controller has a single index action for the site settings menu items.

« More »

Iface

RMS Interfaces Model

Interfaces represent an RMS interface. It contains information about the name and class information. Ifaces is used to prevent using the reserved PHP keyword interface.

« More »

IfacesController

Interfaces Controller

An interface contains information about the name of the interface and class definition. Ifaces is used to prevent using the reserved PHP keyword interface.

« More »

Im

Ims Model

Interactive markers represent ROS interactive marker settings. It contains information about the ROS topic.

« More »

ImsController

Interactive Marker Settings Controller

An interactive marker contains information about the ROS interactive marker topic.

« More »

InteractiveWorldInterfaceController

Interactive World Interface Controller

The Interactive World interface controller. This interface will allow for access to the interactive world.

« More »

InterfaceController

Main Interface Controller

All interfaces should extend the interface controller. This provides useful functions such as checking if a user is authorized to view the given interface.

« More »

Iwmodel

Interactive World Model

An interactive world model is linked to a condition and contains the JSON message of the models.

« More »

IwmodelsController

Interactive World Model Controller

The Interactive World model controller. This interface will allow for access to models via JSON. Other functions allow the visualization of the data in the Interactive World.

« More »

Log

Log Model

Logs are used to store study log data.

« More »

LogsController

Study Logs Controller

Study logs contain log information from a study appointment.

« More »

Marker

Markers Model

Markers represent ROS 3D marker settings. It contains information about the ROS topic.

« More »

MarkersController

Marker Settings Controller

A marker contains information about the ROS 3D marker topic.

« More »

Mjpeg

Mjpegs Model

Mjpegs represent a MJPEG servers. It contains information about the port and host.

« More »

MjpegsController

MJPEG Servers Controller

A MJPEG server contains information about the host and port.

« More »

Page

Pages Model

Pages display a series of articles as content on the RMS. Each page has many articles. A page has a title and menu entry name.

« More »

PagesController

Content Pages Controller

Content pages contain information about the given RMS site. Each content page has a number of articles associated with it. Menu items for these pages are automatically generated. The content page with the first index will be defined as the homepage.

« More »

Protocol

Protocols Model

Protocols define rosbridge transport protocols. Currently, these models cannot be modified via the admin interface as they should remain constant for proper functionality.

« More »

ReminderShell

Study Reminder Shell

The study reminder shell will check for all appointments within the next 30 minutes. A reminder email will then be sent to any user who is subscribed to reminder emails. This is typically run in a cron job.

« More »

Resource

Resource Model

Resources represent Collada resource servers for use with ros3djs.

« More »

ResourcesController

Resource Servers Controller

Resource servers contain information about a Collada resource server for ros3djs.

« More »

RmsHelper

RMS Helper

The RMS helper adds useful functions for making use of the RMS JavaScript library.

« More »

Role

Roles Model

Roles define different user types for the RMS. Currently, these models cannot be modified via the admin interface as they should remain constant for proper functionality.

« More »

Rosbridge

Rosbridges Model

Rosbridges represent a rosbridge servers. It contains information about the port, host, and protocol.

« More »

RosbridgesController

rosbridge Servers Controller

A rosbridge server contains information about the protocol, host, port, and optional rosauth key.

« More »

RosController

ROS Controller

The ROS controller has a single index action for the ROS menu items.

« More »

Setting

Settings Model

RMS settings contain information about parameters such as the site name and copyright message.

« More »

SettingsController

Site Settings Controller

Site settings include options such as the site title, copyright message, and Google Analytics tracking. These settings can only be edited by an admin.

« More »

Slot

Slot Model

Slots represent a user study session slot. It contains information about the associated interface, environment, and start/end time.

« More »

SlotsController

Study Session Slots Controller

A user study session slot contains information about the associated start/end time and associated condition/environment.

« More »

Stream

Streams Model

Streams represent a MJPEG server streams. It contains information about the ROS image topic and streaming parameters.

« More »

StreamsController

MJPEG Server Streams Controller

A MJPEG server stream contains information about the ROS image topic and streaming parameters.

« More »

StudiesController

User Studies Controller

A user study contains information about the name of the study, access controls, and start/end dates.

« More »

Study

Study Model

Studies represent a user study. It contains information about the name, access settings, and start/end dates.

« More »

Subscription

Subscriptions Model

Subscription settings allow users to enable/disable automated emails.

« More »

SubscriptionsController

Email Subscriptions Controller

Email subscriptions control what types of automated emails a user can get.

« More »

Teleop

Telops Model

Teleops represent teleoperation settings. It contains information about the ROS topic and throttle rates.

« More »

TeleopsController

Teleoperation Settings Controller

A teleoperation contains information about the geometry_msgs/Twist topic and optional throttle rate.

« More »

Tf

Tfs Model

TFs represent TF client settings. It contains information about the fixed frame and throttle rates.

« More »

TfsController

TF Client Settings Controller

A TF client setting contains information about the fixed frame and associated environment.

« More »

Type

Types Model

Types define user study log data types. Currently, these models cannot be modified via the admin interface as they should remain constant for proper functionality.

« More »

UpdateShell

RMS Update Shell

The update shell will update the RMS to the latest version.

« More »

Urdf

Urdfs Model

URDF settings. It contains information about the ROS parameters and Collada loaders.

« More »

UrdfsController

URDF Settings Controller

An URDF contains information about the ROS parameter and Collada resources.

« More »

User

Users Model

Users can either be of type admin or basic. Information about the user's name and email are stored inside their account as well as login information.

« More »

UsersController

Users Controller

The users controller manages the account creation, modification, and removal of user and admin accounts. This controller also manages basic authentication mechanisms used throughout the RMS.

« More »

WidgetController

Widget Controller

The widget controller is the main page for editing ROS topics and widgets. This is made to keep the admin panel cleaner instead of creating new pages for each.

« More »