Difference between revisions of "ReqsManagement"

From Event-B
Jump to navigationJump to search
imported>Jastram
(New page: == Description == The Requirements Plugin... * Manages Text-Based Requirements * Requirements are managed and edited in an external Tool (currently Latex, Plain Text and OpenOffice) * ...)
 
imported>Jastram
Line 23: Line 23:
 
== Developer Documentation ==
 
== Developer Documentation ==
  
The Requirements Plug-in actually consists of two:
+
The Requirements Plug-in has the plug-in ID fr.systerel.reqsmgr
  
* DocGenerator
+
=== Architecture ===
* ReqsMgr
 
  
=== DocGenerator ===
+
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.
  
=== ReqsMgr ===
+
=== 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.

Revision as of 12:11, 21 July 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.

Status

The Requirements-Plug-In is currently available through CVS only and not yet useable.

User Documentation

Currently, a new Requirements Project is created by manually creating a file, ending in .req, containing the following:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<root>
</root>

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.