drasil-theory-0.1.0.0: A framework for code and document generation for scientific software - Theory SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Theory.Drasil.GenDefn

Description

Defines types and functions for General Definitions.

Synopsis

Type

data GenDefn Source #

A general definition is a ModelKind that may have units, a derivation, references (as DecRefs), a shortname, a reference address, and notes.

Instances

Instances details
Idea GenDefn Source #

Finds the idea contained in the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

getA :: GenDefn -> Maybe String #

NamedIdea GenDefn Source #

Finds the term (NP) of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

term :: Lens' GenDefn NP #

MayHaveUnit GenDefn Source #

Finds the units of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

CommonIdea GenDefn Source #

Finds the idea of a GenDefn (abbreviation).

Instance details

Defined in Theory.Drasil.GenDefn

Methods

abrv :: GenDefn -> String #

ConceptDomain GenDefn Source #

Finds the domain of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

cdom :: GenDefn -> [UID] #

Definition GenDefn Source #

Finds the definition of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

defn :: Lens' GenDefn Sentence #

HasAdditionalNotes GenDefn Source #

Finds the units of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

getNotes :: Lens' GenDefn [Sentence] #

HasDecRef GenDefn Source #

Finds DecRefs contained in the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

getDecRefs :: Lens' GenDefn [DecRef] #

MayHaveDerivation GenDefn Source #

Finds the derivation of the GenDefn. May contain Nothing.

Instance details

Defined in Theory.Drasil.GenDefn

Express GenDefn Source #

Converts the GenDefns related expression into a ModelExpr.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

express :: GenDefn -> ModelExpr #

HasRefAddress GenDefn Source #

Finds the reference address of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

getRefAdd :: GenDefn -> LblType #

Referable GenDefn Source #

Finds the reference address of a GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

HasShortName GenDefn Source #

Finds the ShortName of the GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

HasUID GenDefn Source #

Finds the UID of a GenDefn.

Instance details

Defined in Theory.Drasil.GenDefn

Methods

uid :: Getter GenDefn UID #

Constructors

gd :: IsUnit u => ModelKind ModelExpr -> Maybe u -> Maybe Derivation -> [DecRef] -> String -> [Sentence] -> GenDefn Source #

Smart constructor for general definitions.

gdNoRefs :: IsUnit u => ModelKind ModelExpr -> Maybe u -> Maybe Derivation -> String -> [Sentence] -> GenDefn Source #

Smart constructor for general definitions with no references.

Functions

getEqModQdsFromGd :: [GenDefn] -> [ModelQDef] Source #

Grab all related QDefinitions from a list of general definitions.