| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.Sections.Requirements
Description
Defines functions used in the Requirements section.
Synopsis
- reqF :: [Section] -> Section
- reqInputsRef :: Reference
- fReqF :: [Contents] -> Section
- fullReqs :: (Quantity i, MayHaveUnit i) => [i] -> Sentence -> [ConceptInstance] -> [ConceptInstance]
- fullTables :: (Quantity i, MayHaveUnit i) => [i] -> [LabelledContent] -> [LabelledContent]
- inReq :: Sentence -> ConceptInstance
- inTable :: (Quantity i, MayHaveUnit i) => [i] -> LabelledContent
- mkInputPropsTable :: (Quantity i, MayHaveUnit i, HasShortName r, Referable r) => [i] -> r -> LabelledContent
- mkQRTuple :: (HasOutput i, HasShortName i, Referable i) => [i] -> [(QuantityDict, Sentence)]
- mkQRTupleRef :: (Quantity i, MayHaveUnit i, HasShortName r, Referable r) => [i] -> [r] -> [(QuantityDict, Sentence)]
- mkValsSourceTable :: (Quantity i, MayHaveUnit i) => [(i, Sentence)] -> String -> Sentence -> LabelledContent
- nfReqF :: [Contents] -> Section
- mkMaintainableNFR :: String -> Integer -> String -> ConceptInstance
Requirements
reqInputsRef :: Reference Source #
Reference for the Required Inputs table.
Functional Requirements
fReqF :: [Contents] -> Section Source #
Adds a generalized introduction for a Non-Fucntional Requirements section. Takes in the contents of that section.
Input Requirements
fullReqs :: (Quantity i, MayHaveUnit i) => [i] -> Sentence -> [ConceptInstance] -> [ConceptInstance] Source #
Prepends a ConceptInstance referencing an input-value table to a list of other ConceptInstances.
For listing input requirements.
fullTables :: (Quantity i, MayHaveUnit i) => [i] -> [LabelledContent] -> [LabelledContent] Source #
Prepends given LabelledContent to an input-value table.
inReq :: Sentence -> ConceptInstance Source #
Creates a ConceptInstance of input values.
inTable :: (Quantity i, MayHaveUnit i) => [i] -> LabelledContent Source #
Creates a generalized input-value table for the Requirements section.
mkInputPropsTable :: (Quantity i, MayHaveUnit i, HasShortName r, Referable r) => [i] -> r -> LabelledContent Source #
Creates an Input Data Table for use in the Functional Requirments section. Takes a list of wrapped variables and something that is Referable.
mkQRTuple :: (HasOutput i, HasShortName i, Referable i) => [i] -> [(QuantityDict, Sentence)] Source #
mkQRTupleRef :: (Quantity i, MayHaveUnit i, HasShortName r, Referable r) => [i] -> [r] -> [(QuantityDict, Sentence)] Source #
mkValsSourceTable :: (Quantity i, MayHaveUnit i) => [(i, Sentence)] -> String -> Sentence -> LabelledContent Source #
Creates a table for use in the Functional Requirments section. Takes a list of tuples containing variables and sources, a label, and a caption.
Non-functional Requirements
nfReqF :: [Contents] -> Section Source #
Adds a generalized introduction for a Non-Fucntional Requirements section. Takes in the contents of that section.
mkMaintainableNFR :: String -> Integer -> String -> ConceptInstance Source #