kcd-0.2.0.0: Kayak .kcd parsing library.

Safe HaskellNone
LanguageHaskell2010

Text.Kcd.Parser

Description

import qualified Kcd.Parser as KCD
main = do
  kcd <- KCD.parseKcdFile "example.kcd"
  print kcd

Synopsis

Documentation

data Bus Source #

network transport system that transfers the data between several nodes.

Constructors

Bus 

Fields

Instances

Eq Bus Source # 

Methods

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

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

Show Bus Source # 

Methods

showsPrec :: Int -> Bus -> ShowS #

show :: Bus -> String #

showList :: [Bus] -> ShowS #

data Consumer Source #

Network node that is a user/receiver of the assigned signal.

Constructors

Consumer 

data Document Source #

Describes the scope of application e.g. the target vehicle or controlled device.

Constructors

Document 

Fields

data Label Source #

Descriptive name for a single value e.g. to describe an enumeration, mark special,invalid or error values.

Constructors

Label 

Fields

Instances

Eq Label Source # 

Methods

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

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

Show Label Source # 

Methods

showsPrec :: Int -> Label -> ShowS #

show :: Label -> String #

showList :: [Label] -> ShowS #

data LabelGroup Source #

Constructors

LabelGroup 

Fields

data Message Source #

Constructors

Message 

Fields

data Multiplex Source #

A looping counter to make a group of signals (MuxGroup) alternately active at a time.

Constructors

Multiplex 

Fields

data MuxGroup Source #

A group of signals that is just valid when the count value of the group matches with the looping | counter (Multiplex).

Constructors

MuxGroup 

Fields

data Node Source #

An endpoint connected to the network (e.g. an electronic control unit) that is able to | send messages to or receive messages from other endpoints.

Constructors

Node 

Fields

Instances

Eq Node Source # 

Methods

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

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

Show Node Source # 

Methods

showsPrec :: Int -> Node -> ShowS #

show :: Node -> String #

showList :: [Node] -> ShowS #

data NodeRef Source #

An endpoint connected to the network that is able to send messages to or receive messages from other endpoints.

Constructors

NodeRef 

Fields

  • _nodeRefId :: Text

    Referencing a network node by its unique identifier.

newtype Notes Source #

Describes the purpose of the signalvariable andor comments on its usage.

Constructors

Notes Text 

Instances

Eq Notes Source # 

Methods

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

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

Show Notes Source # 

Methods

showsPrec :: Int -> Notes -> ShowS #

show :: Notes -> String #

showList :: [Notes] -> ShowS #

data Producer Source #

Origin network node that is the sender of the assigned message.

Constructors

Producer 

data Signal Source #

A discrete part of information contained in the payload of a message.

Constructors

Signal 

Fields

Instances

data Value Source #

Details of how the raw value of the signal/variable shall be interpreted.

Constructors

Value 

Fields

  • _valueMin :: Double

    Lower validity limit of the interpreted value after using the slope/intercept equation.

  • _valueMax :: Double

    Upper validity limit of the interpreted value after using the slope/intercept equation.

  • _valueSlope :: Double

    The slope "m" of a linear equation y = mx + b.

  • _valueIntercept :: Double

    The y-axis intercept "b" of a linear equation y = mx + b.

  • _valueUnit :: Text

    Physical unit of the value written as unit term as described in "The Unified Code for Units of Measure" | (http ::/unitsofmeasure.orgucum.html)

  • _valueType :: ValueType

    Datatype of the value e.g. "unsigned","signed" or IEE754 "single", "double".

Instances

Eq Value Source # 

Methods

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

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

Show Value Source # 

Methods

showsPrec :: Int -> Value -> ShowS #

show :: Value -> String #

showList :: [Value] -> ShowS #

data Var Source #

A variable, a symbolic name associated to a chunk of information (e.g. a string or a value).

Constructors

Var 

Fields

Instances

Eq Var Source # 

Methods

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

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

Show Var Source # 

Methods

showsPrec :: Int -> Var -> ShowS #

show :: Var -> String #

showList :: [Var] -> ShowS #