| 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
- inReqWTab :: (Quantity q, MayHaveUnit q) => Maybe Sentence -> [q] -> (ConceptInstance, LabelledContent)
- mkInputPropsTable :: (Quantity i, MayHaveUnit i) => [i] -> LabelledContent
- mkQRTuple :: (HasOutput i, HasShortName i, Referable i) => [i] -> [(DefinedQuantityDict, Sentence)]
- mkQRTupleRef :: (Quantity i, MayHaveUnit i, Concept i, HasShortName r, Referable r) => [i] -> [r] -> [(DefinedQuantityDict, Sentence)]
- mkValsSourceTable :: (Quantity i, MayHaveUnit i, Concept i) => [(i, Sentence)] -> String -> Sentence -> LabelledContent
- nfReqF :: [Contents] -> Section
- mkMaintainableNFR :: String -> Integer -> String -> ConceptInstance
- mkPortableNFR :: String -> [String] -> String -> ConceptInstance
- mkCorrectNFR :: String -> String -> ConceptInstance
- mkVerifiableNFR :: String -> String -> ConceptInstance
- mkUnderstandableNFR :: String -> String -> ConceptInstance
- mkReusableNFR :: String -> String -> ConceptInstance
- mkSecurityNFR :: String -> 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
inReqWTab :: (Quantity q, MayHaveUnit q) => Maybe Sentence -> [q] -> (ConceptInstance, LabelledContent) Source #
Creates an "input-values" functional requirement (ConceptInstance) and an
associated table of input variables (LabelledContent) from a list of
quantities. The 'Maybe Sentence' provides an optional description for what
the inputs define.
The resulting requirement sentence is of the form: "Inputs the values from
table_ref, which define description". If the description is Nothing,
the sentence is: "Inputs the values from table_ref".
mkInputPropsTable :: (Quantity i, MayHaveUnit i) => [i] -> 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] -> [(DefinedQuantityDict, Sentence)] Source #
mkQRTupleRef :: (Quantity i, MayHaveUnit i, Concept i, HasShortName r, Referable r) => [i] -> [r] -> [(DefinedQuantityDict, Sentence)] Source #
mkValsSourceTable :: (Quantity i, MayHaveUnit i, Concept 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 #
mkPortableNFR :: String -> [String] -> String -> ConceptInstance Source #
Common Non-Functional Requirement for Portability.
mkCorrectNFR :: String -> String -> ConceptInstance Source #
Common Non-Functional Requirement for Correctness.
mkVerifiableNFR :: String -> String -> ConceptInstance Source #
Common Non-Functional Requirement for Verifiability.
mkUnderstandableNFR :: String -> String -> ConceptInstance Source #
Common Non-Functional Requirement for Understandability.
mkReusableNFR :: String -> String -> ConceptInstance Source #
Common Non-Functional Requirement for Reusability.
mkSecurityNFR :: String -> String -> ConceptInstance Source #
Common Non-Functional Requirement for Security.