ReqsManagement: Difference between revisions

From Event-B
Jump to navigationJump to search
imported>Mathieu
m Robot: Changing Category:Developer Documentation
imported>Jastram
No edit summary
Line 13: Line 13:
== Status ==
== Status ==


The Requirements-Plug-In is currently available through CVS only and not yet useable.
(as of 10-Nov-08) The Requirements Plug-In is usable, but broken for Rodin 0.9.0.  It is currently being fixed.  Once fixed, it can be installed through the ProB-Update-Site.


== User Documentation ==
== User Documentation ==


Currently, a new Requirements Project is created by manually creating a file, ending in .req, containing the following:
You find the User Documentation [[Requirements Tutorial|here]].
 
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<root>
</root>


== Developer Documentation ==
== Developer Documentation ==

Revision as of 15:35, 10 November 2008

Description

The Requirements Plugin...

  • Manages Text-Based Requirements
  • Requirements are managed and edited in an external Tool (currently Latex, Plain Text and OpenOffice)
  • Multiple Requirement Specifications can be managed in a Requirements Project.
  • A Requirements Project manages Links between individual requirements and the Event-B Specification.

Status

(as of 10-Nov-08) The Requirements Plug-In is usable, but broken for Rodin 0.9.0. It is currently being fixed. Once fixed, it can be installed through the ProB-Update-Site.

User Documentation

You find the User Documentation here.

Developer Documentation

The Requirements Plug-in has the plug-in ID fr.systerel.reqsmgr

Architecture

The "Connection" between a Requirements Document (managed and edited outside Rodin) and an Event-B Machine is a .req file. This file can manage any number of Requirements Documents.

Package Structure

The package name space is fr.systerel.reqsmgr

  • The elemnts-Package contains the interfaces to the entities inside Rodin, which are Associations, Documents and Requirements. The elements.basis package provides implementations of those interfaces. This package is a good starting point for understanding the data structures.
  • The exteranl_docs package contains the interfaces to entities outside Rodin, which are Document, ExternalRequirement, etc.