Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.Sections.SpecificSystemDescription

Contents

Specific System Description
- Problem Description
- Solution Characteristics Specification
Subsection Stubs

Description

Defines functions used to create the Specific System Description section.

Synopsis

specSysDescr :: [Section] -> Section
probDescF :: Sentence -> [Section] -> Section
termDefnF :: Concept c => Maybe Sentence -> [c] -> Section
termDefnF' :: Maybe Sentence -> [Contents] -> Section
physSystDesc :: Idea a => a -> [Sentence] -> LabelledContent -> [Contents] -> Section
goalStmtF :: [Sentence] -> [Contents] -> Int -> Section
solutionCharSpecIntro :: Idea a => a -> Section -> Contents
assumpF :: [Contents] -> Section
thModF :: Idea a => a -> [Contents] -> Section
genDefnF :: [Contents] -> Section
dataDefnF :: Sentence -> [Contents] -> Section
inModelF :: Section -> Section -> Section -> Section -> [Contents] -> Section
datConF :: (HasUncertainty c, Quantity c, Constrained c, HasReasVal c, MayHaveUnit c) => Sentence -> [c] -> Section
inDataConstTbl :: (HasUncertainty c, Quantity c, Constrained c, HasReasVal c, MayHaveUnit c) => [c] -> LabelledContent
outDataConstTbl :: (Quantity c, Constrained c) => [c] -> LabelledContent
propCorSolF :: (Quantity c, Constrained c) => [c] -> [Contents] -> Section
auxSpecSent :: Sentence
tInDataCstRef :: Reference
tOutDataCstRef :: Reference
helperCI :: ConceptInstance -> SystemInformation -> ConceptInstance
tmStub :: Section
ddStub :: Section
gdStub :: Section
imStub :: Section
pdStub :: Section

Specific System Description

specSysDescr :: [Section] -> Section Source #

Specific System Description section builder.

Problem Description

probDescF :: Sentence -> [Section] -> Section Source #

Describes a problem the system is needed to accomplish.

termDefnF :: Concept c => Maybe Sentence -> [c] -> Section Source #

Creates the Terms and Definitions section. Can take a (Just Sentence) if needed or Nothing if not. Also takes Concepts that contain the definitions.

termDefnF' :: Maybe Sentence -> [Contents] -> Section Source #

Similar to termDefnF, except does not take definitions from the list of terms.

physSystDesc :: Idea a => a -> [Sentence] -> LabelledContent -> [Contents] -> Section Source #

General introduction for the Physical System Description section.

goalStmtF :: [Sentence] -> [Contents] -> Int -> Section Source #

General constructor for the Goal Statement section. Takes the given inputs (Sentences) and the descriptions (Contents).

Solution Characteristics Specification

solutionCharSpecIntro :: Idea a => a -> Section -> Contents Source #

General introduction for the Solution Characteristics Specification section. Takes the program name and a section of instance models.

assumpF :: [Contents] -> Section Source #

Creates an Assumptions section by prepending a general introduction to other related Contents.

thModF :: Idea a => a -> [Contents] -> Section Source #

Wrapper for thModelIntro. Takes the program name and other Contents.

genDefnF :: [Contents] -> Section Source #

Creates a General Definitions section with a general introduction. Takes in relevant general definitions (Contents). Use empty list if none are needed.

dataDefnF :: Sentence -> [Contents] -> Section Source #

Similar to genDefnF, but for Data Definitions. It also uses EmptyS if the ending Sentence is not needed rather than an empty list.

inModelF :: Section -> Section -> Section -> Section -> [Contents] -> Section Source #

Constructor for Instance Models. Takes the problem description, data definition, theoretical model, general definition, and any other relevant contents.

datConF :: (HasUncertainty c, Quantity c, Constrained c, HasReasVal c, MayHaveUnit c) => Sentence -> [c] -> Section Source #

Constructor for Data Constraints section. Takes a trailing Sentence (use EmptyS if none) and data constraints.

inDataConstTbl :: (HasUncertainty c, Quantity c, Constrained c, HasReasVal c, MayHaveUnit c) => [c] -> LabelledContent Source #

Creates the input Data Constraints Table.

outDataConstTbl :: (Quantity c, Constrained c) => [c] -> LabelledContent Source #

Creates the output Data Constraints Table.

propCorSolF :: (Quantity c, Constrained c) => [c] -> [Contents] -> Section Source #

Creates the Properties of a Correct Solution section.

auxSpecSent :: Sentence Source #

General Sentence that describes some auxiliary specifications of the system.

tInDataCstRef :: Reference Source #

Input/Output Data Constraint Table references.