Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Chunk.Concept.Core

Contents

Concept-related Datatypes

Description

Define concept-related chunks. A concept is usually something that has a term, definition, and comes from some domain of knowledge.

Synopsis

data ConceptChunk = ConDict IdeaDict Sentence [UID]
data ConceptInstance = ConInst ConceptChunk String ShortName
sDom :: [UID] -> UID

Concept-related Datatypes

data ConceptChunk Source #

The ConceptChunk datatype records a concept that contains an idea (IdeaDict), a definition (Sentence), and an associated domain of knowledge ([UID]).

Ex. The concept of Accuracy may be defined as the quality or state of being correct or precise.

Constructors

ConDict IdeaDict Sentence [UID]

Instances

Instances details

Idea ConceptChunk Source #	Finds the idea contained in the `IdeaDict` used to make the `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods getA :: ConceptChunk -> Maybe String Source #
NamedIdea ConceptChunk Source #	Finds term (`NP`) of the `IdeaDict` used to make the `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods term :: Lens' ConceptChunk NP Source #
ConceptDomain ConceptChunk Source #	Finds the domain of `UID`s of a `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods cdom :: ConceptChunk -> [UID] Source #
Definition ConceptChunk Source #	Finds definition of a `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods defn :: Lens' ConceptChunk Sentence Source #
HasUID ConceptChunk Source #	Finds `UID` of the `IdeaDict` used to make the `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods uid :: Getter ConceptChunk UID Source #
Eq ConceptChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods (==) :: ConceptChunk -> ConceptChunk -> Bool # (/=) :: ConceptChunk -> ConceptChunk -> Bool #

data ConceptInstance Source #

Contains a ConceptChunk, reference address, and a ShortName. It is a concept that can be referred to, or rather, a instance of where a concept is applied. Often used in Goal Statements, Assumptions, Requirements, etc.

Ex. Something like the assumption that gravity is 9.81 m/s. When we write our equations, we can then link this assumption so that we do not have to explicitly define that assumption when needed to verify our work.

Constructors

ConInst ConceptChunk String ShortName

Instances

Instances details

Idea ConceptInstance Source #	Finds the idea contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods getA :: ConceptInstance -> Maybe String Source #
NamedIdea ConceptInstance Source #	Finds term (`NP`) of the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods term :: Lens' ConceptInstance NP Source #
ConceptDomain ConceptInstance Source #	Finds the domain contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods cdom :: ConceptInstance -> [UID] Source #
Definition ConceptInstance Source #	Finds the definition contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods defn :: Lens' ConceptInstance Sentence Source #
HasRefAddress ConceptInstance Source #	Finds the reference address contained in a `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods getRefAdd :: ConceptInstance -> LblType Source #
Referable ConceptInstance Source #	Finds the reference information contained in a `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods refAdd :: ConceptInstance -> String Source # renderRef :: ConceptInstance -> LblType Source #
HasShortName ConceptInstance Source #	Finds the `ShortName` contained in a `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods shortname :: ConceptInstance -> ShortName Source #
HasUID ConceptInstance Source #	Finds `UID` of the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods uid :: Getter ConceptInstance UID Source #
Eq ConceptInstance Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods (==) :: ConceptInstance -> ConceptInstance -> Bool # (/=) :: ConceptInstance -> ConceptInstance -> Bool #

sDom :: [UID] -> UID Source #

Check if something has one domain. Throws an error if there is more than one.