| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.System
Synopsis
- type Purpose = [Sentence]
- type Background = [Sentence]
- type Scope = [Sentence]
- type Motivation = [Sentence]
- data SystemMeta
- class HasSystemMeta c where
- systemMeta :: Lens' c SystemMeta
- authors :: Lens' c People
- background :: Lens' c Background
- motivation :: Lens' c Motivation
- purpose :: Lens' c Purpose
- scope :: Lens' c Scope
- sysName :: Lens' c CI
- systemdb :: Lens' c ChunkDB
- mkSystemMeta :: CI -> People -> Purpose -> Background -> Scope -> Motivation -> ChunkDB -> SystemMeta
- data DrasilWebsite
- mkDrasilWebsite :: SystemMeta -> [Reference] -> DrasilWebsite
- webRefs :: Lens' DrasilWebsite (Map UID Reference)
- data LessonPlan
- mkLessonPlan :: SystemMeta -> [Reference] -> LessonPlan
- lsnPlanRefs :: Lens' LessonPlan (Map UID Reference)
- data SmithEtAlSRS where
- ICO :: (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]
- lbldCntnt :: Lens' c [LabelledContent]
- meta :: Lens' c SystemMeta
- programName :: Lens' c String
- quantities :: Lens' c [DefinedQuantityDict]
- refTable :: Lens' c (Map UID Reference)
- 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] -> [h] -> [i] -> [j] -> [ConstQDef] -> [DefinedQuantityDict] -> [LabelledContent] -> ChunkDB -> [Reference] -> SmithEtAlSRS
- refbyLookup :: UID -> SmithEtAlSRS -> [UID]
- traceLookup :: UID -> SmithEtAlSRS -> [UID]
Documentation
type Background = [Sentence] Source #
Project Example background information, used in the What section of
README.
type Motivation = [Sentence] Source #
Project Example motivation.
data SystemMeta Source #
Instances
| HasSystemMeta SystemMeta Source # | |
Defined in Drasil.System.Core Methods systemMeta :: Lens' SystemMeta SystemMeta Source # authors :: Lens' SystemMeta People Source # background :: Lens' SystemMeta Background Source # motivation :: Lens' SystemMeta Motivation Source # purpose :: Lens' SystemMeta Purpose Source # scope :: Lens' SystemMeta Scope Source # sysName :: Lens' SystemMeta CI Source # systemdb :: Lens' SystemMeta ChunkDB Source # | |
class HasSystemMeta c where Source #
Minimal complete definition
Methods
systemMeta :: Lens' c SystemMeta Source #
authors :: Lens' c People Source #
background :: Lens' c Background Source #
motivation :: Lens' c Motivation Source #
purpose :: Lens' c Purpose Source #
scope :: Lens' c Scope Source #
Instances
mkSystemMeta :: CI -> People -> Purpose -> Background -> Scope -> Motivation -> ChunkDB -> SystemMeta Source #
data DrasilWebsite Source #
Instances
| HasSystemMeta DrasilWebsite Source # | |
Defined in Drasil.System.DrasilWebsite Methods systemMeta :: Lens' DrasilWebsite SystemMeta Source # authors :: Lens' DrasilWebsite People Source # background :: Lens' DrasilWebsite Background Source # motivation :: Lens' DrasilWebsite Motivation Source # purpose :: Lens' DrasilWebsite Purpose Source # scope :: Lens' DrasilWebsite Scope Source # sysName :: Lens' DrasilWebsite CI Source # systemdb :: Lens' DrasilWebsite ChunkDB Source # | |
mkDrasilWebsite :: SystemMeta -> [Reference] -> DrasilWebsite Source #
data LessonPlan Source #
Instances
| HasSystemMeta LessonPlan Source # | |
Defined in Drasil.System.LessonPlan Methods systemMeta :: Lens' LessonPlan SystemMeta Source # authors :: Lens' LessonPlan People Source # background :: Lens' LessonPlan Background Source # motivation :: Lens' LessonPlan Motivation Source # purpose :: Lens' LessonPlan Purpose Source # scope :: Lens' LessonPlan Scope Source # sysName :: Lens' LessonPlan CI Source # systemdb :: Lens' LessonPlan ChunkDB Source # | |
mkLessonPlan :: SystemMeta -> [Reference] -> LessonPlan Source #
lsnPlanRefs :: Lens' LessonPlan (Map UID Reference) Source #
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] Source #
Project Example background information, used in the What section of
README.
type Motivation = [Sentence] Source #
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 #
lbldCntnt :: Lens' c [LabelledContent] Source #
meta :: Lens' c SystemMeta Source #
programName :: Lens' c String Source #
quantities :: Lens' c [DefinedQuantityDict] Source #
refTable :: Lens' c (Map UID Reference) Source #
refbyTable :: Lens' c (Map UID [UID]) Source #
theoryModels :: Lens' c [TheoryModel] Source #
Instances
| HasSmithEtAlSRS SmithEtAlSRS Source # | |
Defined in Drasil.System.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 # lbldCntnt :: Lens' SmithEtAlSRS [LabelledContent] Source # meta :: Lens' SmithEtAlSRS SystemMeta Source # programName :: Lens' SmithEtAlSRS String Source # quantities :: Lens' SmithEtAlSRS [DefinedQuantityDict] Source # refTable :: Lens' SmithEtAlSRS (Map UID Reference) 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] -> [h] -> [i] -> [j] -> [ConstQDef] -> [DefinedQuantityDict] -> [LabelledContent] -> ChunkDB -> [Reference] -> 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.