plham.main

Class Simulator

plham.Env

plham.main.Simulator

Direct Known Subclasses:

Main

abstract public class Simulator
extends Env

A base class for simulation models. See plham.main.Runner for execution models. See the subclass plham.Main for the core methods.

Nested Class Summary

Nested classes/interfaces inherited from class plham.Env

Env.MarketsFlat

Field Summary

Fields

Modifier and Type	Field and Description
JSON.Value	CONFIG The JSON config file.
Map<String,Any>	GLOBAL It stores the return values of createMarkets(), createAgents(), and createEvents().
Random	RANDOM The root of all instances of Random.

Fields inherited from class plham.Env

DEBUG, agents, hifreqAgents, localAgents, markets, marketsF, normalAgents, orders

Constructor Summary

Constructors

Constructor and Description
Simulator()

Method Summary

Modifier and Type	Method and Description
abstract void	beginSession(String sessionName)
abstract void	beginSimulation()
abstract List<Agent>	createAgents(JSON.Value json)
List<Agent>	createAllAgents(JSON.Value list)
List<Event>	createAllEvents(JSON.Value list)
List<Market>	createAllMarkets(JSON.Value list)
abstract List<Event>	createEvents(JSON.Value json)
Fundamentals	createFundamentals(List<Market> markets, JSON.Value json) Create an instance of Fundamentals based on the JSON object.
protected <T> List<T>	createItemGroup(JSON.Value json, String className, String keyword) For the item grouping technology based on the idea of keyword chain in JSON.
abstract List<Market>	createMarkets(JSON.Value json)
abstract void	endSession(String sessionName)
abstract void	endSimulation()
<T> T	getItemByName(JSON.Value json) Get an item (instance) stored in GLOBAL by the name.
<T> T	getItemByName(String name) Get an item (instance) stored in GLOBAL by the name.
<T> List<T>	getItemsByName(JSON.Value json) Get a list of items (instances) stored in GLOBAL specified by the list of names.
<T> List<T>	getItemsByName(String name) Get a list of items (instances) stored in GLOBAL by the name.
<T> List<T>	getItemsByName(Fun_0_1 <Long,String> names, Long n) Declaration: getItemsByName[T](names:(Long)=>String, n:Long):List[T]. Get a list of items (instances) stored in GLOBAL specified by the list of names.
Random	getRandom() Get the root of all instances of Random (allowed to call only at the place 0).
abstract void	print(String sessionName)
void	updateFundamentals(Fundamentals f) For system use only.
void	updateMarketsUsingFundamentalPrice(List<Market> markets, Fundamentals fundamentals) For system use only.
void	updateMarketsUsingMarketPrice(List<Market> markets, Fundamentals fundamentals) For system use only.

Methods inherited from class plham.Env

addOrders, getenvOrElse, initMarketsF, prepareMarketsF, receiveMarketsF

Field Detail

GLOBAL

public Map<String,Any> GLOBAL

It stores the return values of createMarkets(), createAgents(), and createEvents().

CONFIG

public JSON.Value CONFIG

The JSON config file.

RANDOM

public Random RANDOM

The root of all instances of Random.

Constructor Detail

Simulator

public Simulator()

Method Detail

getRandom

public Random getRandom()

Get the root of all instances of Random (allowed to call only at the place 0).

Returns:

the root

beginSimulation

public abstract void beginSimulation()

endSimulation

public abstract void endSimulation()

beginSession

public abstract void beginSession(String sessionName)

endSession

public abstract void endSession(String sessionName)

print

public abstract void print(String sessionName)

createItemGroup

protected <T> List<T> createItemGroup(JSON.Value json,
                                               String className,
                                               String keyword)

For the item grouping technology based on the idea of keyword chain in JSON.

Parameters:

json -

className - a dummy class name, e.g., "AgentGroup"

keyword - a name for keyword chain, e.g., "agents"

Returns:

a list of items

createAllMarkets

public List<Market> createAllMarkets(JSON.Value list)

createMarkets

public abstract List<Market> createMarkets(JSON.Value json)

createAllAgents

public List<Agent> createAllAgents(JSON.Value list)

createAgents

public abstract List<Agent> createAgents(JSON.Value json)

createAllEvents

public List<Event> createAllEvents(JSON.Value list)

createEvents

public abstract List<Event> createEvents(JSON.Value json)

createFundamentals

public Fundamentals createFundamentals(List<Market> markets,
                                       JSON.Value json)

Create an instance of Fundamentals based on the JSON object.

Parameters:

markets -

json - a JSON object, or properties of correlations of fundamentals

Returns:

a fundamentals

updateFundamentals

public void updateFundamentals(Fundamentals f)

For system use only.

updateMarketsUsingFundamentalPrice

public void updateMarketsUsingFundamentalPrice(List<Market> markets,
                                               Fundamentals fundamentals)

For system use only.

updateMarketsUsingMarketPrice

public void updateMarketsUsingMarketPrice(List<Market> markets,
                                          Fundamentals fundamentals)

For system use only.

getItemsByName

public <T> List<T> getItemsByName(String name)

Get a list of items (instances) stored in GLOBAL by the name.

Parameters:

name - a section name defined in the JSON config file.

Returns:

a list of instances having the name.

getItemByName

public <T> T getItemByName(String name)

Get an item (instance) stored in GLOBAL by the name. Since in GLOBAL even a single item is stored as List, the size must be 1. This throws an exception if the size is > 1.

Parameters:

name - a section name defined in the JSON config file.

Returns:

an instance having the name.

getItemsByName

public <T> List<T> getItemsByName(Fun_0_1 <Long,String> names,
                                           Long n)

Declaration: getItemsByName[T](names:(Long)=>String, n:Long):List[T].

Get a list of items (instances) stored in GLOBAL specified by the list of names.

Parameters:

names - section names defined in the JSON config file.

n - the length of names.

Returns:

a list of instances having the names.

getItemsByName

public <T> List<T> getItemsByName(JSON.Value json)

Get a list of items (instances) stored in GLOBAL specified by the list of names.

Parameters:

json - section name(s) (String or List) defined in the JSON config file.

Returns:

a list of instances having the name(s).

getItemByName

public <T> T getItemByName(JSON.Value json)

Get an item (instance) stored in GLOBAL by the name. Since in GLOBAL even a single item is stored as List, the size must be 1. This throws an exception if the size is > 1.

Parameters:

json - a section name (String or List) defined in the JSON config file.

Returns:

an instance having the name.