rmtoo-constraints(5)

NAME
rmtoo-constraints - requirements management tool: constraints format

FILE FORMAT
Each constraint must be in its own file. The filename must be end in '.ctr'. Only ASCII characters are allowed. Each line must at maximum 80 characters long.

The constraint must be written as a set of 'key: value' pairs. A value is extended if the first column of a line is a space.

A key can only exists once in a constraint description file.

KEYS
The following keys with the described syntax and semantic exists:

KEY 'Name'
This value of this key is a short headline for the constraint.

KEY 'Invented on'
The value of 'Invented on' is the date when the constraint was written. The format must be YYYY-MM-DD.

KEY 'Invented by'
This value is the name of the author of the constraint.

KEY 'Owner'
This is the owner of the constraint. He is responsible for the constraint.

KEY 'Description'
The description is the formulation of the constraint. There must be

KEY 'Note'
The note is an additional comment for the constraint.

KEY 'CE3'
This defines the class for the constraint execution and evaluation environment. The class must follow a specific interface with a special semantic. Please see the section CE3 for more details.

CE3
The evaluation for all constraints is started at the master requirement. For each requirement all constraint objects are created - i.e. all those from the list given in the requirement's constraints tag. The parameters given are the parameters which are used to call the object's constructor.

The provided class must have a method called unite. This method has two parameterers: the first is the constraint object of the requirement itself, the second is the list of constraint objects from the parents (the inherited objects).

When it receives only a list of inherited objects, the method must return an object with represents these constraints for the local requirement.

When the method is also called with the constraint object of the requirement itself, the method must check if the local requirement constraint can be hold against the list of inherited constraints from the parents.

EXAMPLE
Please consule the file MinShockResistance.ctr and testcases tests/blackbox-test/bb017-test and tests/blackbox-test/bb018-test.

AUTHOR
Written by Andreas Florath (rmtoo@florath.net)

COPYRIGHT
Copyright © 2011 by flonatel (rmtoo@florath.net). License GPLv3+: GNU GPL version 3 or later