Safe Haskell	None
Language	Haskell2010

Language.Drasil.Chunk.Unital

Contents

Chunk Type
Constructors

Description

Defines chunks to add units to a quantity. Similar to UnitaryChunk.

Synopsis

data UnitalChunk = UC {
- _defq' :: DefinedQuantityDict
- _uni :: UnitDefn
}
makeUCWDS :: IsUnit u => String -> NP -> Sentence -> Symbol -> u -> UnitalChunk
uc :: (Concept c, IsUnit u) => c -> Symbol -> u -> UnitalChunk
uc' :: IsUnit u => String -> NP -> String -> Symbol -> u -> UnitalChunk
ucStaged :: IsUnit u => String -> NP -> String -> (Stage -> Symbol) -> u -> UnitalChunk
ucs :: IsUnit u => String -> NP -> String -> Symbol -> Space -> u -> UnitalChunk
ucs' :: (Concept c, IsUnit u) => c -> Symbol -> Space -> u -> UnitalChunk
ucsWS :: IsUnit u => String -> NP -> Sentence -> Symbol -> Space -> u -> UnitalChunk
ucuc :: (Quantity c, Concept c, MayHaveUnit c) => c -> UnitDefn -> UnitalChunk
ucw :: (Unitary c, Concept c, MayHaveUnit c) => c -> UnitalChunk

Chunk Type

data UnitalChunk Source #

Similar to a DefinedQuantityDict, UnitalChunks are concepts with quantities that must have a unit definition. Contains DefinedQuantityDicts and a UnitDefn.

Ex. A pendulum arm is a tangible object with a symbol (l) and units (cm, m, etc.).

Constructors

UC
Fields _defq' :: DefinedQuantityDict _uni :: UnitDefn

Instances

Instances details

Eq UnitalChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.Unital Methods (==) :: UnitalChunk -> UnitalChunk -> Bool # (/=) :: UnitalChunk -> UnitalChunk -> Bool #
HasUID UnitalChunk Source #	Finds `UID` of the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods uid :: Lens' UnitalChunk UID Source #
HasSymbol UnitalChunk Source #	Finds the `Symbol` of the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods symbol :: UnitalChunk -> Stage -> Symbol Source #
HasSpace UnitalChunk Source #	Finds the `Space` of the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods typ :: Lens' UnitalChunk Space Source #
Express UnitalChunk Source #	Convert the symbol of the `UnitalChunk` to a `ModelExpr`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods express :: UnitalChunk -> ModelExpr Source #
Idea UnitalChunk Source #	Finds the idea contained in the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods getA :: UnitalChunk -> Maybe String Source #
NamedIdea UnitalChunk Source #	Finds term (`NP`) of the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods term :: Lens' UnitalChunk NP Source #
Quantity UnitalChunk Source #	`UnitalChunk`s have a `Quantity`.
Instance details Defined in Language.Drasil.Chunk.Unital
ConceptDomain UnitalChunk Source #	Finds the domain contained in the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods cdom :: UnitalChunk -> [UID] Source #
Definition UnitalChunk Source #	Finds definition of the `DefinedQuantityDict` used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods defn :: Lens' UnitalChunk Sentence Source #
TempHasUnit UnitalChunk Source #	Finds the units used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods findUnit :: UnitalChunk -> UnitDefn Source #
MayHaveUnit UnitalChunk Source #	Finds the units used to make the `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods getUnit :: UnitalChunk -> Maybe UnitDefn Source #
Unitary UnitalChunk Source #	Finds the unit definition of a `UnitalChunk`.
Instance details Defined in Language.Drasil.Chunk.Unital Methods unit :: UnitalChunk -> UnitDefn Source #

Constructors

makeUCWDS :: IsUnit u => String -> NP -> Sentence -> Symbol -> u -> UnitalChunk Source #

Creates a UnitalChunk in the same way as uc', but with a Sentence for the definition instead of a String.

uc :: (Concept c, IsUnit u) => c -> Symbol -> u -> UnitalChunk Source #

Used to create a UnitalChunk from a Concept, Symbol, and Unit. Assumes the Space is Real.

uc' :: IsUnit u => String -> NP -> String -> Symbol -> u -> UnitalChunk Source #

Similar to uc, except it builds the Concept portion of the UnitalChunk from a given UID, term, and definition (which are the first three arguments).

ucStaged :: IsUnit u => String -> NP -> String -> (Stage -> Symbol) -> u -> UnitalChunk Source #

Similar to uc', but Symbol is dependent on the Stage.

ucs :: IsUnit u => String -> NP -> String -> Symbol -> Space -> u -> UnitalChunk Source #

Similar to uc', but does not assume the Space.

ucs' :: (Concept c, IsUnit u) => c -> Symbol -> Space -> u -> UnitalChunk Source #

Similar to uc but does not assume the Space.

ucsWS :: IsUnit u => String -> NP -> Sentence -> Symbol -> Space -> u -> UnitalChunk Source #

Similar to ucs, but uses a Sentence for description.

ucuc :: (Quantity c, Concept c, MayHaveUnit c) => c -> UnitDefn -> UnitalChunk Source #

Attach units to a chunk that has a symbol and definition.

ucw :: (Unitary c, Concept c, MayHaveUnit c) => c -> UnitalChunk Source #

Constructs a UnitalChunk from a Concept with Units.