Classes, interfaces and traits

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 »

Article

Article Model

Articles are used to store content on a given page. They consist of a title and the associated content.
« 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 »

Email

SMTP Email Settings Model

SMTP email settings contain information about email server settings.
« More »

Environment

Environments Model

Environments are linked to a rosbridge and MJPEG server. Each has a unique name.
« 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 »

Im

Ims Model

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

Iwmodel

Interactive World Model

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

Log

Log Model

Logs are used to store study log data.
« More »

Marker

Markers Model

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

Mjpeg

Mjpegs Model

Mjpegs represent a MJPEG servers. It contains information about the port and host.
« 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 »

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 »

Resource

Resource Model

Resources represent Collada resource servers for use with ros3djs.
« 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 »

Setting

Settings Model

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

Slot

Slot Model

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

Stream

Streams Model

Streams represent a MJPEG server streams. It contains information about the ROS image topic and streaming parameters.
« 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 »

Teleop

Telops Model

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

Tf

Tfs Model

TFs represent TF client settings. It contains information about the fixed frame and throttle rates.
« 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 »

Urdf

Urdfs Model

URDF settings. It contains information about the ROS parameters and Collada loaders.
« 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 »