Copyright	Copyright (c) 2009-2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Simulation.Aivika.Results.Locale.Types

Contents

Basic Types
Locale Codes
Localisations
Unique Identifiers
Utilites

Description

Tested with: GHC 8.0.1

The module defines basic definitions for localisation.

Synopsis

type ResultLocale = String
data ResultLocalisation = ResultLocalisation {
- localiseResultDescription :: ResultId -> ResultDescription
- localiseResultTitle :: ResultId -> ResultDescription
}
type ResultName = String
type ResultDescription = String
data UserDefinedResult = UserDefinedResult {
}
data LocalisedResult = LocalisedResult {
- localisedResultDescriptions :: Map ResultLocale ResultDescription
- localisedResultTitles :: Map ResultLocale ResultDescription
}
russianResultLocale :: ResultLocale
englishResultLocale :: ResultLocale
pathResultLocalisation :: (ResultId -> ResultDescription) -> [ResultId] -> ResultDescription
localisePathResultDescription :: ResultLocalisation -> [ResultId] -> ResultDescription
localisePathResultTitle :: ResultLocalisation -> [ResultId] -> ResultDescription
lookupResultLocalisation :: ResultLocale -> Map ResultLocale ResultDescription -> ResultDescription
data ResultId
resultNameToTitle :: ResultName -> ResultDescription

Basic Types

type ResultLocale = String Source #

A locale to output the simulation results.

Examples are: "ru", "en" etc.

data ResultLocalisation Source #

It localises the description and title of simulation results.

Constructors

ResultLocalisation
Fields localiseResultDescription :: ResultId -> ResultDescription Localise the description. localiseResultTitle :: ResultId -> ResultDescription Localise the title.

type ResultName = String Source #

A name used for indentifying the results when generating output.

type ResultDescription = String Source #

A description used for describing the results when generating output.

data UserDefinedResult Source #

It describes the user-defined simulation result.

Constructors

UserDefinedResult
Fields userDefinedResultName :: ResultName The user-defined result name. userDefinedResultDescription :: ResultDescription The user-defined result description. userDefinedResultTitle :: ResultDescription The user-defined result title.

Instances

Instances details

Eq UserDefinedResult Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods (==) :: UserDefinedResult -> UserDefinedResult -> Bool # (/=) :: UserDefinedResult -> UserDefinedResult -> Bool #
Ord UserDefinedResult Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods compare :: UserDefinedResult -> UserDefinedResult -> Ordering # (<) :: UserDefinedResult -> UserDefinedResult -> Bool # (<=) :: UserDefinedResult -> UserDefinedResult -> Bool # (>) :: UserDefinedResult -> UserDefinedResult -> Bool # (>=) :: UserDefinedResult -> UserDefinedResult -> Bool # max :: UserDefinedResult -> UserDefinedResult -> UserDefinedResult # min :: UserDefinedResult -> UserDefinedResult -> UserDefinedResult #
Show UserDefinedResult Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods showsPrec :: Int -> UserDefinedResult -> ShowS # show :: UserDefinedResult -> String # showList :: [UserDefinedResult] -> ShowS #

data LocalisedResult Source #

This is a localisation of the specified simulation result.

Constructors

LocalisedResult
Fields localisedResultDescriptions :: Map ResultLocale ResultDescription The localised descriptions. localisedResultTitles :: Map ResultLocale ResultDescription The localised titles.

Instances

Instances details

Eq LocalisedResult Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods (==) :: LocalisedResult -> LocalisedResult -> Bool # (/=) :: LocalisedResult -> LocalisedResult -> Bool #
Ord LocalisedResult Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods compare :: LocalisedResult -> LocalisedResult -> Ordering # (<) :: LocalisedResult -> LocalisedResult -> Bool # (<=) :: LocalisedResult -> LocalisedResult -> Bool # (>) :: LocalisedResult -> LocalisedResult -> Bool # (>=) :: LocalisedResult -> LocalisedResult -> Bool # max :: LocalisedResult -> LocalisedResult -> LocalisedResult # min :: LocalisedResult -> LocalisedResult -> LocalisedResult #
Show LocalisedResult Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods showsPrec :: Int -> LocalisedResult -> ShowS # show :: LocalisedResult -> String # showList :: [LocalisedResult] -> ShowS #

Locale Codes

russianResultLocale :: ResultLocale Source #

The Russian locale.

englishResultLocale :: ResultLocale Source #

The English locale.

Localisations

pathResultLocalisation :: (ResultId -> ResultDescription) -> [ResultId] -> ResultDescription Source #

Return the path result localisation.

localisePathResultDescription :: ResultLocalisation -> [ResultId] -> ResultDescription Source #

Localise the path result description.

localisePathResultTitle :: ResultLocalisation -> [ResultId] -> ResultDescription Source #

Localise the path result title.

lookupResultLocalisation :: ResultLocale -> Map ResultLocale ResultDescription -> ResultDescription Source #

Lookup a localisation by the specified locale.

Unique Identifiers

data ResultId Source #

The result entity identifier.

Constructors

TimeId	A `time` computation.
VectorId	Describes a vector.
VectorItemId String	Describes a vector item with the specified subscript.
SamplingStatsId	A `SamplingStats` value.
SamplingStatsCountId	Property `samplingStatsCount`.
SamplingStatsMinId	Property `samplingStatsMin`.
SamplingStatsMaxId	Property `samplingStatsMax`.
SamplingStatsMeanId	Property `samplingStatsMean`.
SamplingStatsMean2Id	Property `samplingStatsMean2`.
SamplingStatsVarianceId	Property `samplingStatsVariance`.
SamplingStatsDeviationId	Property `samplingStatsDeviation`.
SamplingCounterId	A `SamplingCounter` value.
SamplingCounterValueId	Property `samplingCounterValue`.
SamplingCounterStatsId	Property `samplingCounterStats`.
TimingStatsId	A `TimingStats` value.
TimingStatsCountId	Property `timingStatsCount`.
TimingStatsMinId	Property `timingStatsMin`.
TimingStatsMaxId	Property `timingStatsMax`.
TimingStatsMeanId	Property `timingStatsMean`.
TimingStatsVarianceId	Property `timingStatsVariance`.
TimingStatsDeviationId	Property `timingStatsDeviation`.
TimingStatsMinTimeId	Property `timingStatsMinTime`.
TimingStatsMaxTimeId	Property `timingStatsMaxTime`.
TimingStatsStartTimeId	Property `timingStatsStartTime`.
TimingStatsLastTimeId	Property `timingStatsLastTime`.
TimingStatsSumId	Property `timingStatsSum`.
TimingStatsSum2Id	Property `timingStatsSum2`.
TimingCounterId	A `TimingCounter` value.
TimingCounterValueId	Property `timingCounterValue`.
TimingCounterStatsId	Property `timingCounterStats`.
FiniteQueueId	A finite `Queue`.
InfiniteQueueId	An infinite `Queue`.
EnqueueStrategyId	Property `enqueueStrategy`.
EnqueueStoringStrategyId	Property `enqueueStoringStrategy`.
DequeueStrategyId	Property `dequeueStrategy`.
QueueNullId	Property `queueNull`.
QueueFullId	Property `queueFull`.
QueueMaxCountId	Property `queueMaxCount`.
QueueCountId	Property `queueCount`.
QueueCountStatsId	Property `queueCountStats`.
EnqueueCountId	Property `enqueueCount`.
EnqueueLostCountId	Property `enqueueLostCount`.
EnqueueStoreCountId	Property `enqueueStoreCount`.
DequeueCountId	Property `dequeueCount`.
DequeueExtractCountId	Property `dequeueExtractCount`.
QueueLoadFactorId	Property `queueLoadFactor`.
EnqueueRateId	Property `enqueueRate`.
EnqueueStoreRateId	Property `enqueueStoreRate`.
DequeueRateId	Property `dequeueRate`.
DequeueExtractRateId	Property `dequeueExtractRate`.
QueueWaitTimeId	Property `queueWaitTime`.
QueueTotalWaitTimeId	Property `queueTotalWaitTime`.
EnqueueWaitTimeId	Property `enqueueWaitTime`.
DequeueWaitTimeId	Property `dequeueWaitTime`.
QueueRateId	Property `queueRate`.
ArrivalTimerId	An `ArrivalTimer`.
ArrivalProcessingTimeId	Property `arrivalProcessingTime`.
ServerId	Represents a `Server`.
ServerInitStateId	Property `serverInitState`.
ServerStateId	Property `serverState`.
ServerTotalInputWaitTimeId	Property `serverTotalInputWaitTime`.
ServerTotalProcessingTimeId	Property `serverTotalProcessingTime`.
ServerTotalOutputWaitTimeId	Property `serverTotalOutputWaitTime`.
ServerTotalPreemptionTimeId	Property `serverTotalPreemptionTime`.
ServerInputWaitTimeId	Property `serverInputWaitTime`.
ServerProcessingTimeId	Property `serverProcessingTime`.
ServerOutputWaitTimeId	Property `serverOutputWaitTime`.
ServerPreemptionTimeId	Property `serverPreemptionTime`.
ServerInputWaitFactorId	Property `serverInputWaitFactor`.
ServerProcessingFactorId	Property `serverProcessingFactor`.
ServerOutputWaitFactorId	Property `serverOutputWaitFactor`.
ServerPreemptionFactorId	Property `serverPreemptionFactor`.
ActivityId	Represents an `Activity`.
ActivityInitStateId	Property `activityInitState`.
ActivityStateId	Property `activityState`.
ActivityTotalUtilisationTimeId	Property `activityTotalUtilisationTime`.
ActivityTotalIdleTimeId	Property `activityTotalIdleTime`.
ActivityTotalPreemptionTimeId	Property `activityTotalPreemptionTime`.
ActivityUtilisationTimeId	Property `activityUtilisationTime`.
ActivityIdleTimeId	Property `activityIdleTime`.
ActivityPreemptionTimeId	Property `activityPreemptionTime`.
ActivityUtilisationFactorId	Property `activityUtilisationFactor`.
ActivityIdleFactorId	Property `activityIdleFactor`.
ActivityPreemptionFactorId	Property `activityPreemptionFactor`.
ResourceId	Represents a `Resource`.
ResourceCountId	Property `resourceCount`.
ResourceCountStatsId	Property `resourceCountStats`.
ResourceUtilisationCountId	Property `resourceUtilisationCount`.
ResourceUtilisationCountStatsId	Property `resourceUtilisationCountStats`.
ResourceQueueCountId	Property `resourceQueueCount`.
ResourceQueueCountStatsId	Property `resourceQueueCountStats`.
ResourceTotalWaitTimeId	Property `resourceTotalWaitTime`.
ResourceWaitTimeId	Property `resourceWaitTime`.
OperationId	Represents an `Operation`.
OperationTotalUtilisationTimeId	Property `operationTotalUtilisationTime`.
OperationTotalPreemptionTimeId	Property `operationTotalPreemptionTime`.
OperationUtilisationTimeId	Property `operationUtilisationTime`.
OperationPreemptionTimeId	Property `operationPreemptionTime`.
OperationUtilisationFactorId	Property `operationUtilisationFactor`.
OperationPreemptionFactorId	Property `operationPreemptionFactor`.
UserDefinedResultId UserDefinedResult	An user defined description.
LocalisedResultId LocalisedResult	A localised property or object name.

Instances

Instances details

Eq ResultId Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods (==) :: ResultId -> ResultId -> Bool # (/=) :: ResultId -> ResultId -> Bool #
Ord ResultId Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods compare :: ResultId -> ResultId -> Ordering # (<) :: ResultId -> ResultId -> Bool # (<=) :: ResultId -> ResultId -> Bool # (>) :: ResultId -> ResultId -> Bool # (>=) :: ResultId -> ResultId -> Bool # max :: ResultId -> ResultId -> ResultId # min :: ResultId -> ResultId -> ResultId #
Show ResultId Source #
Instance details Defined in Simulation.Aivika.Results.Locale.Types Methods showsPrec :: Int -> ResultId -> ShowS # show :: ResultId -> String # showList :: [ResultId] -> ShowS #

Utilites

resultNameToTitle :: ResultName -> ResultDescription Source #

Convert the result name to title.