| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
SysInfo.Drasil
Synopsis
- data SystemInformation where
- SI :: (CommonIdea a, Idea a, Idea b, Quantity e, Eq e, MayHaveUnit e, Quantity h, MayHaveUnit h, Quantity i, MayHaveUnit i, HasUID j, Constrained j) => {..} -> SystemInformation
- class HasSystemInformation c where
- systemInformation :: Lens' c SystemInformation
- authors :: Lens' c People
- background :: Lens' c Background
- configFiles :: Lens' c [String]
- constants :: Lens' c [ConstQDef]
- datadefs :: Lens' c [DataDefinition]
- instModels :: Lens' c [InstanceModel]
- motivation :: Lens' c Motivation
- purpose :: Lens' c Purpose
- scope :: Lens' c Scope
- sysinfodb :: Lens' c ChunkDB
- usedinfodb :: Lens' c ChunkDB
- type Purpose = [Sentence]
- type Background = [Sentence]
- type Scope = [Sentence]
- type Motivation = [Sentence]
- citeDB :: SystemInformation -> BibRef
- ccss :: [Sentence] -> [ModelExpr] -> ChunkDB -> [DefinedQuantityDict]
- ccss' :: [Sentence] -> [ModelExpr] -> ChunkDB -> [QuantityDict]
- vars :: ModelExpr -> ChunkDB -> [QuantityDict]
System Information
data SystemInformation where Source #
Data structure for holding all of the requisite information about a system to be used in artifact generation.
Constructors
| SI | |
Fields
| |
Instances
| HasSystemInformation SystemInformation Source # | |
Defined in SysInfo.Drasil.SystemInformation Methods systemInformation :: Lens' SystemInformation SystemInformation Source # authors :: Lens' SystemInformation People Source # background :: Lens' SystemInformation Background Source # configFiles :: Lens' SystemInformation [String] Source # constants :: Lens' SystemInformation [ConstQDef] Source # datadefs :: Lens' SystemInformation [DataDefinition] Source # instModels :: Lens' SystemInformation [InstanceModel] Source # motivation :: Lens' SystemInformation Motivation Source # purpose :: Lens' SystemInformation Purpose Source # scope :: Lens' SystemInformation Scope Source # sysinfodb :: Lens' SystemInformation ChunkDB Source # usedinfodb :: Lens' SystemInformation ChunkDB Source # | |
Lenses
class HasSystemInformation c where Source #
Minimal complete definition
Methods
systemInformation :: Lens' c SystemInformation Source #
authors :: Lens' c People Source #
background :: Lens' c Background Source #
configFiles :: Lens' c [String] Source #
constants :: Lens' c [ConstQDef] Source #
datadefs :: Lens' c [DataDefinition] Source #
instModels :: Lens' c [InstanceModel] Source #
motivation :: Lens' c Motivation Source #
purpose :: Lens' c Purpose Source #
scope :: Lens' c Scope Source #
sysinfodb :: Lens' c ChunkDB Source #
usedinfodb :: Lens' c ChunkDB Source #
Instances
| HasSystemInformation SystemInformation Source # | |
Defined in SysInfo.Drasil.SystemInformation Methods systemInformation :: Lens' SystemInformation SystemInformation Source # authors :: Lens' SystemInformation People Source # background :: Lens' SystemInformation Background Source # configFiles :: Lens' SystemInformation [String] Source # constants :: Lens' SystemInformation [ConstQDef] Source # datadefs :: Lens' SystemInformation [DataDefinition] Source # instModels :: Lens' SystemInformation [InstanceModel] Source # motivation :: Lens' SystemInformation Motivation Source # purpose :: Lens' SystemInformation Purpose Source # scope :: Lens' SystemInformation Scope Source # sysinfodb :: Lens' SystemInformation ChunkDB Source # usedinfodb :: Lens' SystemInformation ChunkDB Source # | |
Reference Database
type Background = [Sentence] Source #
Project Example background information, used in the What section of README.
type Motivation = [Sentence] Source #
Project Example motivation.
citeDB :: SystemInformation -> BibRef Source #
Helper for extracting a bibliography from the system information.
Utility Helper Functions
ccss :: [Sentence] -> [ModelExpr] -> ChunkDB -> [DefinedQuantityDict] Source #
Gets a list of defined quantities (DefinedQuantityDicts) from Sentences and expressions that are contained in the database (ChunkDB).
ccss' :: [Sentence] -> [ModelExpr] -> ChunkDB -> [QuantityDict] Source #
Gets a list of quantities (QuantityDicts) from Sentences and expressions that are contained in the database (ChunkDB).
vars :: ModelExpr -> ChunkDB -> [QuantityDict] Source #
Gets a list of quantities (QuantityDict) from an equation in order to print.