research_package_model library

The domain model part of Research Package. Contains the "building blocks" for creating surveys and obtaining informed consents. Holds the different types of result classes. Also responsible for the streams and BLoC classes to provide communication channels between different parts of the package. (BlocQuestion, BlocTask) For the UI representations of the classes visit the research_package_ui library.

Classes

BlocTask
The BLoC file for the communication between the task RPUIOrderedTask and its steps RPStep.
CanSaveResult
A protocol to mark the Widgets which are producing RPResult objects. They all need to implement the createAndSendResult method
RPAnswerFormat
A base (abstract) class for different Answer Formats. [...]
RPChoice
The choice object which the participant can choose during a RPQuestionStep with RPChoiceAnswerFormat.
RPChoiceAnswerFormat
Class representing an Answer Format that lets participants choose from a fixed set of choices.
RPCompletionStep
A step which can be used as a "Thank you" or completion step in a task.
RPConsentDocument
Represents the content of an informed consent document. [...]
RPConsentReviewStep
The step for presenting the consent document for review and collecting the signature [...]
RPConsentSection
A content section in a RPConsentDocument. [...]
RPConsentSignature
Class representing a signature in a consent document [...]
RPConsentSignatureResult
Represents a signature applied to a given consent document. It indicates if a given consent document has been signed by a user.
RPFormAnswerFormat
Class representing the Answer Format for Form Questions (Multiple questions at the same time on the same page)
RPFormStep
The RPFormStep class is a concrete subclass of RPQuestionStep, used for presenting multiple questions on a single scrollable page. [...]
RPInstructionStep
A step which can be used to communicate instructions to the participants Usually it is used as the first step in a Task.
RPIntegerAnswerFormat
Class representing an Answer Format that lets participants input a number (integer)
RPOrderedTask
RPQuestionStep
The concrete subclass of RPStep that represents a step in which a single question is presented to the user. [...]
RPResult
The superclass for results. It defines the attributes which all the more specialized results classes should have.
RPSignatureResult
The signature used in RPConsentSignatureResult [...]
RPStep
The base class for steps which can compose a task. [...]
RPStepResult
The result object a Step creates
RPTask
The RPTask abstract class defines a task to be carried out by a participant in a research study. [...]
RPTaskProgress
Simple class for keeping track the progress of the task. It contains the number of the current step and the total number of steps. [...]
RPTaskResult
The result object a Task creates
RPVisualConsentStep
The step used for presenting the consent document to the participant [...]

Properties

blocTask BlocTask
The singleton object of the task BLoC class which can be accessed throughout Research Package.
final

Enums

ChoiceAnswerStyle
Available types for RPChoiceAnswerFormat
QuestionType
RPConsentSectionType
Enum containing the available types for RPConsentSection. [...]
StepStatus
Status to be sent to the Bloc so the Task Widget is notified about the navigation