License	BSD-3-Clause
Safe Haskell	None
Language	Haskell2010

Swarm.Language.Requirements.Type

Contents

Requirements
- The Requirement type
- The Requirements type and utility functions

Description

A requirement is something that is needed in order to successfully build a robot running a certain program.

Synopsis

data Requirement
- = ReqCap Capability
- | ReqDev Text
- | ReqInv Int Text
data Requirements = Requirements {
- capReqs :: Set Capability
- devReqs :: Set Text
- invReqs :: Map Text Int
}
singleton :: Requirement -> Requirements
singletonCap :: Capability -> Requirements
singletonDev :: Text -> Requirements
singletonInv :: Int -> Text -> Requirements
insert :: Requirement -> Requirements -> Requirements
type ReqCtx = Ctx Var Requirements

Requirements

The `Requirement` type

data Requirement Source #

A requirement is something a robot must have when it is built. There are three types: - A robot can require a certain Capability, which should be fulfilled by equipping an appropriate device. - A robot can require a specific device, which should be equipped. - A robot can stock some number of a specific entity in its inventory.

Constructors

ReqCap Capability

Require a specific capability. This must be fulfilled by equipping an appropriate device. Requiring the same capability multiple times is the same as requiring it once.

ReqDev Text

Require a specific device to be equipped. Note that at this point it is only a name, and has not been resolved to an actual Entity. That's because programs have to be type- and capability-checked independent of an EntityMap. The name will be looked up at runtime, when actually executing a Build or Reprogram command, and an appropriate exception thrown if a device with the given name does not exist.

Requiring the same device multiple times is the same as requiring it once.

ReqInv Int Text

Stock a certain number of a specific entity to be available in the inventory. The same comments apply re: resolving the entity name to an actual Entity.

Inventory requirements are additive, that is, say, requiring 5 of entity "e" and later requiring 7 is the same as requiring 12.

Instances

Instances details

FromJSON Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

parseJSON :: Value -> Parser Requirement #

parseJSONList :: Value -> Parser [Requirement] #

omittedField :: Maybe Requirement #

ToJSON Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

toJSON :: Requirement -> Value #

toEncoding :: Requirement -> Encoding #

toJSONList :: [Requirement] -> Value #

toEncodingList :: [Requirement] -> Encoding #

omitField :: Requirement -> Bool #

Data Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Requirement -> c Requirement #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Requirement #

toConstr :: Requirement -> Constr #

dataTypeOf :: Requirement -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Requirement) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Requirement) #

gmapT :: (forall b. Data b => b -> b) -> Requirement -> Requirement #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Requirement -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Requirement -> r #

gmapQ :: (forall d. Data d => d -> u) -> Requirement -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Requirement -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Requirement -> m Requirement #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Requirement -> m Requirement #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Requirement -> m Requirement #

Generic Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Associated Types

type Rep Requirement

Instance details

Defined in Swarm.Language.Requirements.Type

type Rep Requirement = D1 ('MetaData "Requirement" "Swarm.Language.Requirements.Type" "swarm-0.7.0.0-IuFfgHrMoE7JrptOBRVOwx-swarm-lang" 'False) (C1 ('MetaCons "ReqCap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Capability)) :+: (C1 ('MetaCons "ReqDev" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "ReqInv" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

Methods

from :: Requirement -> Rep Requirement x #

to :: Rep Requirement x -> Requirement #

Show Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

showsPrec :: Int -> Requirement -> ShowS #

show :: Requirement -> String #

showList :: [Requirement] -> ShowS #

Eq Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

(==) :: Requirement -> Requirement -> Bool #

(/=) :: Requirement -> Requirement -> Bool #

Ord Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

compare :: Requirement -> Requirement -> Ordering #

(<) :: Requirement -> Requirement -> Bool #

(<=) :: Requirement -> Requirement -> Bool #

(>) :: Requirement -> Requirement -> Bool #

(>=) :: Requirement -> Requirement -> Bool #

max :: Requirement -> Requirement -> Requirement #

min :: Requirement -> Requirement -> Requirement #

Hashable Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

Methods

hashWithSalt :: Int -> Requirement -> Int #

hash :: Requirement -> Int #

type Rep Requirement Source #

Instance details

Defined in Swarm.Language.Requirements.Type

type Rep Requirement = D1 ('MetaData "Requirement" "Swarm.Language.Requirements.Type" "swarm-0.7.0.0-IuFfgHrMoE7JrptOBRVOwx-swarm-lang" 'False) (C1 ('MetaCons "ReqCap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Capability)) :+: (C1 ('MetaCons "ReqDev" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "ReqInv" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

The `Requirements` type and utility functions

data Requirements Source #

It is tempting to define Requirements = Set Requirement, but that would be wrong, since two identical ReqInv should have their counts added rather than simply being deduplicated.

Since we will eventually need to deal with the different types of requirements separately, it makes sense to store them separately anyway.

Constructors