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

Instances

Instances details

Generic PassBy Source #
Instance details Defined in Language.Drasil.Chunk.Parameter Associated Types type Rep PassBy :: Type -> Type # Methods from :: PassBy -> Rep PassBy x # to :: Rep PassBy x -> PassBy #
HasChunkRefs PassBy Source #
Instance details Defined in Language.Drasil.Chunk.Parameter Methods chunkRefs :: PassBy -> Set UID #
type Rep PassBy Source #
Instance details Defined in Language.Drasil.Chunk.Parameter type Rep PassBy = D1 ('MetaData "PassBy" "Language.Drasil.Chunk.Parameter" "drasil-code-0.1.9.0-JHqDOLqdCU6DtuKMA6xOju" 'False) (C1 ('MetaCons "Val" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ref" 'PrefixI 'False) (U1 :: Type -> Type))

data ParameterChunk Source #

Chunk representing a parameter.

Constructors

PC
Fields _pcc :: CodeChunk passBy :: PassBy

Instances

Instances details

Generic ParameterChunk Source #
Instance details Defined in Language.Drasil.Chunk.Parameter Associated Types type Rep ParameterChunk :: Type -> Type # Methods from :: ParameterChunk -> Rep ParameterChunk x # to :: Rep ParameterChunk x -> ParameterChunk #
HasChunkRefs ParameterChunk Source #
Instance details Defined in Language.Drasil.Chunk.Parameter Methods chunkRefs :: ParameterChunk -> Set UID #
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 (`Sentence`) 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 #
ConceptDomain ParameterChunk Source #
Instance details Defined in Language.Drasil.Chunk.Parameter Methods cdom :: ParameterChunk -> [UID] #
Definition ParameterChunk Source #	Finds the definition of the `CodeChunk` used to make the `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods defn :: Lens' ParameterChunk Sentence #
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 #
type Rep ParameterChunk Source #
Instance details Defined in Language.Drasil.Chunk.Parameter type Rep ParameterChunk = D1 ('MetaData "ParameterChunk" "Language.Drasil.Chunk.Parameter" "drasil-code-0.1.9.0-JHqDOLqdCU6DtuKMA6xOju" 'False) (C1 ('MetaCons "PC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_pcc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeChunk) :*: S1 ('MetaSel ('Just "passBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PassBy)))

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.