Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.System

Contents

System

Synopsis

data System where
- SI :: (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j) => {..} -> System
data SystemKind
- = Specification
- | RunnableSoftware
- | Notebook
- | Website
type Purpose = [Sentence]
type Background = [Sentence]
type Scope = [Sentence]
type Motivation = [Sentence]
class HasSystem c where
- system :: Lens' c System
- constants :: Lens' c [ConstQDef]
- dataDefns :: Lens' c [DataDefinition]
- genDefns :: Lens' c [GenDefn]
- instModels :: Lens' c [InstanceModel]
- kind :: Lens' c SystemKind
- meta :: Lens' c SystemMeta
- programName :: Lens' c String
- refTable :: Lens' c (Map UID Reference)
- refbyTable :: Lens' c (Map UID [UID])
- theoryModels :: Lens' c [TheoryModel]
- traceTable :: Lens' c (Map UID [UID])
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
whatsTheBigIdea :: System -> IdeaDict
mkSystem :: (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j) => CI -> SystemKind -> People -> Purpose -> Background -> Scope -> Motivation -> [TheoryModel] -> [GenDefn] -> [DataDefinition] -> [InstanceModel] -> [h] -> [i] -> [j] -> [ConstQDef] -> ChunkDB -> [Reference] -> System
refbyLookup :: UID -> System -> [UID]
traceLookup :: UID -> System -> [UID]

System

Types

data System where Source #

Data structure for holding all of the requisite information about a system to be used in artifact generation.

Constructors

SI

Fields

:: (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j)
=> { _meta :: SystemMeta
, _kind :: SystemKind
, _programName :: String
, _theoryModels :: [TheoryModel]
, _genDefns :: [GenDefn]
, _dataDefns :: [DataDefinition]
, _instModels :: [InstanceModel]
, _inputs :: [h]
, _outputs :: [i]
, _constraints :: [j]
, _constants :: [ConstQDef]
, _refTable :: Map UID Reference
, _refbyTable :: Map UID [UID]
, _traceTable :: Map UID [UID]
} -> System

Instances

Instances details

HasSystemMeta System Source #
Instance details Defined in Drasil.System.OldSystem Methods systemMeta :: Lens' System SystemMeta Source # authors :: Lens' System People Source # background :: Lens' System Background Source # motivation :: Lens' System Motivation Source # purpose :: Lens' System Purpose Source # scope :: Lens' System Scope Source # sysName :: Lens' System CI Source # systemdb :: Lens' System ChunkDB Source #
HasSystem System Source #
Instance details Defined in Drasil.System.OldSystem Methods system :: Lens' System System Source # constants :: Lens' System [ConstQDef] Source # dataDefns :: Lens' System [DataDefinition] Source # genDefns :: Lens' System [GenDefn] Source # instModels :: Lens' System [InstanceModel] Source # kind :: Lens' System SystemKind Source # meta :: Lens' System SystemMeta Source # programName :: Lens' System String Source # refTable :: Lens' System (Map UID Reference) Source # refbyTable :: Lens' System (Map UID [UID]) Source # theoryModels :: Lens' System [TheoryModel] Source # traceTable :: Lens' System (Map UID [UID]) Source #

data SystemKind Source #

Enumeration of kinds of Systems we can encode.

Constructors

Specification
RunnableSoftware
Notebook
Website

type Purpose = [Sentence] Source #

Project Example purpose.

type Background = [Sentence] Source #

Project Example background information, used in the What section of README.

type Scope = [Sentence] Source #

Project Example scope.

type Motivation = [Sentence] Source #

Project Example motivation.

Lenses

class HasSystem c where Source #

Minimal complete definition

system

Methods

system :: Lens' c System Source #

constants :: Lens' c [ConstQDef] Source #

dataDefns :: Lens' c [DataDefinition] Source #

genDefns :: Lens' c [GenDefn] Source #

instModels :: Lens' c [InstanceModel] Source #

kind :: Lens' c SystemKind Source #

meta :: Lens' c SystemMeta Source #

programName :: Lens' c String Source #

refTable :: Lens' c (Map UID Reference) Source #

refbyTable :: Lens' c (Map UID [UID]) Source #

theoryModels :: Lens' c [TheoryModel] Source #

traceTable :: Lens' c (Map UID [UID]) Source #

Instances

Instances details

HasSystem System Source #

Instance details

Defined in Drasil.System.OldSystem

Methods

system :: Lens' System System Source #

constants :: Lens' System [ConstQDef] Source #

dataDefns :: Lens' System [DataDefinition] Source #

genDefns :: Lens' System [GenDefn] Source #

instModels :: Lens' System [InstanceModel] Source #

kind :: Lens' System SystemKind Source #

meta :: Lens' System SystemMeta Source #

programName :: Lens' System String Source #

refTable :: Lens' System (Map UID Reference) Source #

refbyTable :: Lens' System (Map UID [UID]) Source #

theoryModels :: Lens' System [TheoryModel] Source #

traceTable :: Lens' System (Map UID [UID]) Source #

class HasSystemMeta c where Source #

Minimal complete definition

systemMeta

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 #

sysName :: Lens' c CI Source #

systemdb :: Lens' c ChunkDB Source #

Instances

Instances details

HasSystemMeta System Source #
Instance details Defined in Drasil.System.OldSystem Methods systemMeta :: Lens' System SystemMeta Source # authors :: Lens' System People Source # background :: Lens' System Background Source # motivation :: Lens' System Motivation Source # purpose :: Lens' System Purpose Source # scope :: Lens' System Scope Source # sysName :: Lens' System CI Source # systemdb :: Lens' System ChunkDB Source #

Functions

whatsTheBigIdea :: System -> IdeaDict Source #

Probe what kind of System one is. For example, does it represent a (Problem) specification, runnable software, a notebook, or a website?

mkSystem :: (Quantity h, MayHaveUnit h, Concept h, Quantity i, MayHaveUnit i, Concept i, HasUID j, Constrained j) => CI -> SystemKind -> People -> Purpose -> Background -> Scope -> Motivation -> [TheoryModel] -> [GenDefn] -> [DataDefinition] -> [InstanceModel] -> [h] -> [i] -> [j] -> [ConstQDef] -> ChunkDB -> [Reference] -> System Source #

Build a System.

Hacks

refbyLookup :: UID -> System -> [UID] Source #

Find what chunks reference a specific chunk.

traceLookup :: UID -> System -> [UID] Source #

Find what chunks a specific one references.