Safe Haskell	Safe-Inferred
Language	Haskell2010

Theory.Drasil.DataDefinition

Description

Defines types and functions for Data Definitions.

Synopsis

data DataDefinition
ddQD :: Lens' SimpleQDef a -> Lens' ModelQDef a -> Lens' DataDefinition a
ddE :: SimpleQDef -> [DecRef] -> Maybe Derivation -> String -> [Sentence] -> DataDefinition
ddME :: ModelQDef -> [DecRef] -> Maybe Derivation -> String -> [Sentence] -> DataDefinition
ddENoRefs :: SimpleQDef -> Maybe Derivation -> String -> [Sentence] -> DataDefinition
ddMENoRefs :: ModelQDef -> Maybe Derivation -> String -> [Sentence] -> DataDefinition
qdFromDD :: DataDefinition -> Either SimpleQDef ModelQDef
qdEFromDD :: DataDefinition -> Maybe SimpleQDef

Documentation

data DataDefinition Source #

A data definition is a QDefinition that may have additional notes: the scope, any references (as DecRefs), maybe a derivation, a label (ShortName), a reference address, and other notes (Sentences).

Instances

Instances details

HasChunkRefs DataDefinition Source #
Instance details Defined in Theory.Drasil.DataDefinition Methods chunkRefs :: DataDefinition -> Set UID #
HasUID DataDefinition Source #	Finds the `UID` of a 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods uid :: Getter DataDefinition UID #
DefinesQuantity DataDefinition Source #	Finds the `Quantity` defined by the `DataDefinition`
Instance details Defined in Theory.Drasil.DataDefinition Methods defLhs :: Getter DataDefinition DefinedQuantityDict #
Idea DataDefinition Source #	Finds the idea contained in the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getA :: DataDefinition -> Maybe String #
NamedIdea DataDefinition Source #	Finds the term (`Sentence`) of the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods term :: Lens' DataDefinition NP #
CommonIdea DataDefinition Source #	Finds the idea of a 'DataDefinition where' (abbreviation).
Instance details Defined in Theory.Drasil.DataDefinition Methods abrv :: DataDefinition -> String #
ConceptDomain DataDefinition Source #	Finds the domain of the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods cdom :: DataDefinition -> [UID] #
HasAdditionalNotes DataDefinition Source #	Finds any additional notes for the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getNotes :: Lens' DataDefinition [Sentence] #
HasDecRef DataDefinition Source #	Finds `DecRef`s contained in the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getDecRefs :: Lens' DataDefinition [DecRef] #
MayHaveDerivation DataDefinition Source #	Finds the derivation of the 'DataDefinition where'. May contain Nothing.
Instance details Defined in Theory.Drasil.DataDefinition Methods derivations :: Lens' DataDefinition (Maybe Derivation) #
Express DataDefinition Source #	Converts the defining expression of a 'DataDefinition where' into the model expression language.
Instance details Defined in Theory.Drasil.DataDefinition Methods express :: DataDefinition -> ModelExpr #
HasRefAddress DataDefinition Source #	Finds the reference address of a 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getRefAdd :: DataDefinition -> LblType #
Referable DataDefinition Source #	Finds the reference address of a 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods refAdd :: DataDefinition -> String # renderRef :: DataDefinition -> LblType #
HasShortName DataDefinition Source #	Finds the `ShortName` of the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods shortname :: DataDefinition -> ShortName #
HasOutput DataDefinition Source #	Finds the output variable of the `DataDefinition`
Instance details Defined in Theory.Drasil.DataDefinition Methods output :: Getter DataDefinition DefinedQuantityDict Source # out_constraints :: Getter DataDefinition [RealInterval Expr Expr] Source #
Eq DataDefinition Source #	Equal if `UID`s are equal.
Instance details Defined in Theory.Drasil.DataDefinition Methods (==) :: DataDefinition -> DataDefinition -> Bool # (/=) :: DataDefinition -> DataDefinition -> Bool #
RequiresChecking DataDefinition Expr Space Source #	Expose all expressions that need to be type-checked.
Instance details Defined in Theory.Drasil.DataDefinition Methods requiredChecks :: DataDefinition -> [(Expr, Space)] #

ddQD :: Lens' SimpleQDef a -> Lens' ModelQDef a -> Lens' DataDefinition a Source #

ddE :: SimpleQDef -> [DecRef] -> Maybe Derivation -> String -> [Sentence] -> DataDefinition Source #

Smart constructor for data definitions.

ddME :: ModelQDef -> [DecRef] -> Maybe Derivation -> String -> [Sentence] -> DataDefinition Source #

Smart constructor for data definitions.

ddENoRefs :: SimpleQDef -> Maybe Derivation -> String -> [Sentence] -> DataDefinition Source #

Smart constructor for data definitions with no references.

ddMENoRefs :: ModelQDef -> Maybe Derivation -> String -> [Sentence] -> DataDefinition Source #

Smart constructor for data definitions with no references.

qdFromDD :: DataDefinition -> Either SimpleQDef ModelQDef Source #

Extracts the 'QDefinition e' from a DataDefinition.

qdEFromDD :: DataDefinition -> Maybe SimpleQDef Source #