drasil-srs-0.1.26.0: A framework for code and document generation for scientific software - SRS Language SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.SRS.DocumentLanguage.TraceabilityMatrix

Description

Defines functions to create traceability matrices in SRS documents.

Synopsis

Documentation

generateTraceTableView :: UID -> Sentence -> [TraceViewCat] -> [TraceViewCat] -> SmithEtAlSRS -> LabelledContent Source #

Generates a traceability table. Takes a UID for the table, a description (Sentence), columns (TraceViewCat), rows (TraceViewCat), and System.

traceMHeader :: (SmithEtAlSRS -> [UID]) -> SmithEtAlSRS -> [Sentence] Source #

Helper that finds the header of a traceability matrix.

layoutUIDs :: [TraceViewCat] -> SmithEtAlSRS -> [UID] -> [UID] Source #

Helper that finds the layout UIDs of a traceability matrix.

traceMReferees :: ([UID] -> [UID]) -> SmithEtAlSRS -> [UID] Source #

Helper that finds the traceability matrix references (things being referenced).

traceMReferrers :: ([UID] -> [UID]) -> SmithEtAlSRS -> [UID] Source #

Helper that finds the traceability matrix references (things that are referring to other things).

traceMColumns :: ([UID] -> [UID]) -> ([UID] -> [UID]) -> SmithEtAlSRS -> [[UID]] Source #

Helper that makes the columns of a traceability matrix.

traceMIntro :: [LabelledContent] -> [Sentence] -> Contents Source #

Generalized traceability matrix introduction: appends references to the traceability matrices in Sentence form and wraps in Contents. Usually references the four tables generally found in this section (in order of being mentioned).

traceView :: HasUID a => (SmithEtAlSRS -> [a]) -> TraceViewCat Source #

Helper that is similar to traceViewFilt, but the filter is always True.

traceViewCC :: Concept c => c -> TraceViewCat Source #

Turns a Concept into a TraceViewCat via its domain.