| Safe Haskell | None |
|---|---|
| Language | GHC2024 |
Drasil.SRS.SmithEtAlSRS
Description
Define types and functions related to creating a system information database.
Changes to System should be reflected in the 'Creating Your Project in Drasil' tutorial found on the wiki: https://github.com/JacquesCarette/Drasil/wiki/Creating-Your-Project-in-Drasil
Synopsis
- data SmithEtAlSRS where
- ICO :: forall h i j. (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j) => {..} -> SmithEtAlSRS
- type Purpose = [Sentence]
- type Background = [Sentence]
- type Scope = [Sentence]
- type Motivation = [Sentence]
- class HasSmithEtAlSRS c where
- smithEtAlSRS :: Lens' c SmithEtAlSRS
- constants :: Lens' c [ConstQDef]
- dataDefns :: Lens' c [DataDefinition]
- genDefns :: Lens' c [GenDefn]
- instModels :: Lens' c [InstanceModel]
- meta :: Lens' c SystemMeta
- programName :: Lens' c String
- quantities :: Lens' c [DefinedQuantityDict]
- refbyTable :: Lens' c (Map UID [UID])
- theoryModels :: Lens' c [TheoryModel]
- traceTable :: Lens' c (Map UID [UID])
- mkSmithEtAlICO :: (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j) => CI -> People -> Purpose -> Background -> Scope -> Motivation -> [TheoryModel] -> [GenDefn] -> [DataDefinition] -> [InstanceModel] -> NonEmpty h -> NonEmpty i -> [j] -> [ConstQDef] -> [DefinedQuantityDict] -> ChunkDB -> SmithEtAlSRS
- refbyLookup :: UID -> SmithEtAlSRS -> [UID]
- traceLookup :: UID -> SmithEtAlSRS -> [UID]
System ** Types
data SmithEtAlSRS where Source #
Data structure for holding all of the requisite information about a system to be used in artifact generation.
Constructors
| ICO | |
Fields
| |
Instances
type Background = [Sentence] #
Project Example background information, used in the What section of
README.
type Motivation = [Sentence] #
Project Example motivation.
Lenses
class HasSmithEtAlSRS c where Source #
Minimal complete definition
Methods
smithEtAlSRS :: Lens' c SmithEtAlSRS Source #
constants :: Lens' c [ConstQDef] Source #
dataDefns :: Lens' c [DataDefinition] Source #
genDefns :: Lens' c [GenDefn] Source #
instModels :: Lens' c [InstanceModel] Source #
meta :: Lens' c SystemMeta Source #
programName :: Lens' c String Source #
quantities :: Lens' c [DefinedQuantityDict] Source #
refbyTable :: Lens' c (Map UID [UID]) Source #
theoryModels :: Lens' c [TheoryModel] Source #
Instances
| HasSmithEtAlSRS SmithEtAlSRS Source # | |
Defined in Drasil.SRS.SmithEtAlSRS Methods smithEtAlSRS :: Lens' SmithEtAlSRS SmithEtAlSRS Source # constants :: Lens' SmithEtAlSRS [ConstQDef] Source # dataDefns :: Lens' SmithEtAlSRS [DataDefinition] Source # genDefns :: Lens' SmithEtAlSRS [GenDefn] Source # instModels :: Lens' SmithEtAlSRS [InstanceModel] Source # meta :: Lens' SmithEtAlSRS SystemMeta Source # programName :: Lens' SmithEtAlSRS String Source # quantities :: Lens' SmithEtAlSRS [DefinedQuantityDict] Source # refbyTable :: Lens' SmithEtAlSRS (Map UID [UID]) Source # theoryModels :: Lens' SmithEtAlSRS [TheoryModel] Source # traceTable :: Lens' SmithEtAlSRS (Map UID [UID]) Source # | |
Constructors
mkSmithEtAlICO :: (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j) => CI -> People -> Purpose -> Background -> Scope -> Motivation -> [TheoryModel] -> [GenDefn] -> [DataDefinition] -> [InstanceModel] -> NonEmpty h -> NonEmpty i -> [j] -> [ConstQDef] -> [DefinedQuantityDict] -> ChunkDB -> SmithEtAlSRS Source #
Build a System.
Hacks
refbyLookup :: UID -> SmithEtAlSRS -> [UID] Source #
Find what chunks reference a specific chunk.
traceLookup :: UID -> SmithEtAlSRS -> [UID] Source #
Find what chunks a specific one references.