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).

Constructors

DDE :: SimpleQDef -> DDPkt -> DataDefinition
DDME :: ModelQDef -> DDPkt -> DataDefinition

Instances

Instances details

Eq DataDefinition Source #	Equal if `UID`s are equal.
Instance details Defined in Theory.Drasil.DataDefinition Methods (==) :: DataDefinition -> DataDefinition -> Bool # (/=) :: DataDefinition -> DataDefinition -> Bool #
MayHaveUnit DataDefinition Source #	Finds the units of the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getUnit :: DataDefinition -> Maybe UnitDefn #
HasAdditionalNotes DataDefinition Source #	Finds any additional notes for the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getNotes :: Lens' DataDefinition [Sentence] #
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] #
CommonIdea DataDefinition Source #	Finds the idea of a 'DataDefinition where' (abbreviation).
Instance details Defined in Theory.Drasil.DataDefinition Methods abrv :: DataDefinition -> String #
Quantity DataDefinition Source #	'DataDefinition where's have a `Quantity`.
Instance details Defined in Theory.Drasil.DataDefinition
HasDecRef DataDefinition Source #	Finds `DecRef`s contained in the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods getDecRefs :: Lens' DataDefinition [DecRef] #
HasDerivation 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) #
NamedIdea DataDefinition Source #	Finds the term (`NP`) of the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods term :: Lens' DataDefinition NP #
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 #
HasShortName DataDefinition Source #	Finds the `ShortName` of the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods shortname :: DataDefinition -> ShortName #
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 #
HasSpace DataDefinition Source #	Finds the Space of the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods typ :: Lens' DataDefinition Space #
HasSymbol DataDefinition Source #	Finds the Symbol of the `QDefinition` used to make the 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods symbol :: DataDefinition -> Stage -> Symbol #
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 #
HasUID DataDefinition Source #	Finds the `UID` of a 'DataDefinition where'.
Instance details Defined in Theory.Drasil.DataDefinition Methods uid :: Lens' DataDefinition UID #

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

ddPkt :: Lens' DDPkt a -> Lens' DataDefinition a Source #

Constructors

ddE :: SimpleQDef -> [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.

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

Smart constructor for data definitions.

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 #