Safe Haskell	Safe-Inferred
Language	Haskell2010

Theory.Drasil.InstanceModel

Contents

Type
Constructors
Functions

Description

Defines types and functions for Instance Models.

Synopsis

data InstanceModel
im :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> [DecRef] -> Maybe Derivation -> String -> [Sentence] -> InstanceModel
imNoDeriv :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> [DecRef] -> String -> [Sentence] -> InstanceModel
imNoRefs :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> Maybe Derivation -> String -> [Sentence] -> InstanceModel
imNoDerivNoRefs :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> String -> [Sentence] -> InstanceModel
getEqModQdsFromIm :: [InstanceModel] -> [SimpleQDef]
qwUC :: (Quantity q, MayHaveUnit q) => q -> Input
qwC :: (Quantity q, MayHaveUnit q) => q -> RealInterval Expr Expr -> Input

Type

data InstanceModel Source #

An instance model is a ModelKind that may have specific inputs, outputs, and output constraints. It also has attributes like references, derivation, labels (ShortName), reference address, and notes.

Instances

Instances details

Idea InstanceModel Source #	Finds the idea contained in the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods getA :: InstanceModel -> Maybe String #
NamedIdea InstanceModel Source #	Finds the term (`NP`) of the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods term :: Lens' InstanceModel NP #
DefinesQuantity InstanceModel Source #	Finds the `Quantity` of an `InstanceModel`
Instance details Defined in Theory.Drasil.InstanceModel Methods defLhs :: Getter InstanceModel QuantityDict #
CommonIdea InstanceModel Source #	Finds the idea of an `InstanceModel` (abbreviation).
Instance details Defined in Theory.Drasil.InstanceModel Methods abrv :: InstanceModel -> String #
ConceptDomain InstanceModel Source #	Finds the domain of the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods cdom :: InstanceModel -> [UID] #
Definition InstanceModel Source #	Finds the definition of the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods defn :: Lens' InstanceModel Sentence #
HasAdditionalNotes InstanceModel Source #	Finds any additional notes for the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods getNotes :: Lens' InstanceModel [Sentence] #
HasDecRef InstanceModel Source #	Finds `DecRef`s contained in the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods getDecRefs :: Lens' InstanceModel [DecRef] #
MayHaveDerivation InstanceModel Source #	Finds the derivation of the `InstanceModel`. May contain Nothing.
Instance details Defined in Theory.Drasil.InstanceModel Methods derivations :: Lens' InstanceModel (Maybe Derivation) #
Express InstanceModel Source #	Converts the `InstanceModel`s related expression into the display language.
Instance details Defined in Theory.Drasil.InstanceModel Methods express :: InstanceModel -> ModelExpr #
HasRefAddress InstanceModel Source #	Finds the reference address of the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods getRefAdd :: InstanceModel -> LblType #
Referable InstanceModel Source #	Finds the reference address of an `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods refAdd :: InstanceModel -> String # renderRef :: InstanceModel -> LblType #
HasShortName InstanceModel Source #	Finds the `ShortName` of the `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods shortname :: InstanceModel -> ShortName #
HasUID InstanceModel Source #	Finds the `UID` of an `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods uid :: Lens' InstanceModel UID #
HasInputs InstanceModel Source #	Finds the inputs of an `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods inputs :: Lens' InstanceModel [(QuantityDict, Maybe (RealInterval Expr Expr))] Source #
HasOutput InstanceModel Source #	Finds the outputs and output constraints of an `InstanceModel`.
Instance details Defined in Theory.Drasil.InstanceModel Methods output :: Getter InstanceModel QuantityDict Source # out_constraints :: Getter InstanceModel [RealInterval Expr Expr] Source #
RequiresChecking InstanceModel Expr Space Source #	Expose all expressions that need to be type-checked.
Instance details Defined in Theory.Drasil.InstanceModel Methods requiredChecks :: InstanceModel -> [(Expr, Space)] #

Constructors

im :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> [DecRef] -> Maybe Derivation -> String -> [Sentence] -> InstanceModel Source #

Smart constructor for instance models with everything defined.

imNoDeriv :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> [DecRef] -> String -> [Sentence] -> InstanceModel Source #

Smart constructor for instance models with a custom term, and no derivation.

imNoRefs :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> Maybe Derivation -> String -> [Sentence] -> InstanceModel Source #

Smart constructor for instance models with a custom term, and no references.

imNoDerivNoRefs :: ModelKind Expr -> Inputs -> Output -> OutputConstraints -> String -> [Sentence] -> InstanceModel Source #

Smart constructor for instance models with a custom term, and no derivations or references.

Functions

getEqModQdsFromIm :: [InstanceModel] -> [SimpleQDef] Source #

Grab all related QDefinitions from a list of instance models.

qwUC :: (Quantity q, MayHaveUnit q) => q -> Input Source #

For building a quantity with no constraint.

qwC :: (Quantity q, MayHaveUnit q) => q -> RealInterval Expr Expr -> Input Source #

For building a quantity with a constraint.