Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Chunk.Parameter

Synopsis

data PassBy
- = Val
- | Ref
data ParameterChunk = PC {
- _pcc :: CodeChunk
- passBy :: PassBy
}
pcAuto :: CodeIdea c => c -> ParameterChunk
pcVal :: CodeIdea c => c -> ParameterChunk

Documentation

data PassBy Source #

Determines whether a parameter is passed by value or by reference.

Constructors

Val
Ref

data ParameterChunk Source #

Chunk representing a parameter.

Constructors

PC
Fields _pcc :: CodeChunk passBy :: PassBy

Instances

Instances details

HasUID ParameterChunk Source #	Finds the `UID` of the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods uid :: Getter ParameterChunk UID #
CodeIdea ParameterChunk Source #	Finds the code name and `CodeChunk` of a `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods codeName :: ParameterChunk -> String # codeChunk :: ParameterChunk -> CodeChunk #
Idea ParameterChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods getA :: ParameterChunk -> Maybe String #
NamedIdea ParameterChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods term :: Lens' ParameterChunk NP #
MayHaveUnit ParameterChunk Source #	Finds the units of the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods getUnit :: ParameterChunk -> Maybe UnitDefn #
Quantity ParameterChunk Source #	`ParameterChunk`s have a `Quantity`.
Instance details Defined in Language.Drasil.Chunk.Parameter
HasSpace ParameterChunk Source #	Finds the `Space` of the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods typ :: Getter ParameterChunk Space #
HasSymbol ParameterChunk Source #	Finds the `Stage` dependent `Symbol` of the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods symbol :: ParameterChunk -> Stage -> Symbol #
Eq ParameterChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods (==) :: ParameterChunk -> ParameterChunk -> Bool # (/=) :: ParameterChunk -> ParameterChunk -> Bool #

pcAuto :: CodeIdea c => c -> ParameterChunk Source #

Automatically chooses PassBy based on Space (Vectors and Actors passed by reference).

pcVal :: CodeIdea c => c -> ParameterChunk Source #

Constructs a pass-by-value parameter.

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result