Package net.simplace.sim.io

Class FWSimCache

java.lang.Object

net.simplace.sim.io.FWSimCache

All Implemented Interfaces:

FWSimFieldContainer

Direct Known Subclasses:

FWSimResourceCache, FWSimResultCache, FWSimulationControlCache

public abstract class FWSimCache
extends Object
implements FWSimFieldContainer

Out of performance reasons the data from resources is stored within the ResourceCache. Herein a Object[] is used to make the data accessible very fast. See the 2 extending classes: FWSimResourceCache and FWSimResultCache.

Author:

Andreas Enders

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	iArrayMode
protected HashMap<Object,Object[]>	iCache
protected int	iFieldcount
protected FWSimIOAdapter.FREQUENCE	iFrequence
protected LinkedHashMap<String,FWSimVariable<?>>	iHeaderVariables
protected String	iName
protected int	iOrderNumber
protected HashMap<String,Integer>	iVariablesIndexes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FWSimCache(int aFieldcount, String aName, HashMap<Object,Object[]> aCache, boolean aArrayMode, LinkedHashMap<String,FWSimVariable<?>> aHeaderVariables, FWSimIOAdapter.FREQUENCE aFrequence, int aOrderNumber, HashMap<String,Integer> aVariableIndex)
	FWSimCache(LinkedHashMap<String,FWSimVariable<?>> aHeaderVariables, FWSimIOAdapter.FREQUENCE aFrequence, String aName, int aOrderNumber)	constructor from different media types in the fitting structure also used by transformers

Method Summary

Modifier and Type	Method	Description
void	addVariable(FWSimVariable<?> aVariable)	use this method with care - data has to be synchronized with the HeaderVariables
void	checkCondition(Boolean aCheckResult, String aMessage)	Called from inside the FWSimFieldContainer to log the initialization Errors.
HashMap<String,FWSimVariable<?>>	createVariables()
HashMap<Object,Object[]>	getCache()
FWSimVariable.CONTENT_TYPE	getContentType()
int	getFieldcount()
LinkedHashMap<String,FWSimVariable<?>>	getFieldMap()	taken from the HeaderVariables
FWSimIOAdapter.FREQUENCE	getFrequence()
Collection<FWSimVariable<?>>	getInputVariables()	returned list will always be empty! Resources have not input fields
String	getName()
int	getOrderNumber()
Collection<FWSimVariable<?>>	getOutputVariables()	delivers a list from the header information
FWSimVariable<?>	getVariable(String aID)
Integer	getVariableIndex(String aFieldName)
HashMap<String,FWSimVariable<?>>	getVariables()
boolean	isArrayMode()
boolean	isConditionCheck()
void	removeVariable(String aID)	use this method with care - data has to be synchronized with the HeaderVariables
void	setCacheMap(HashMap<Object,Object[]> aNewFieldMap)	setting complete new data structure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.simplace.sim.util.FWSimFieldContainer

getCreateFormXML, getEditFormXML, getVarMap, toXML

Field Details

iFieldcount

protected int iFieldcount

iName

protected String iName

iCache

protected HashMap<Object,Object[]> iCache

iArrayMode

protected boolean iArrayMode

iHeaderVariables

protected LinkedHashMap<String,FWSimVariable<?>> iHeaderVariables

iVariablesIndexes

protected HashMap<String,Integer> iVariablesIndexes

iFrequence

protected FWSimIOAdapter.FREQUENCE iFrequence

iOrderNumber

protected int iOrderNumber

Constructor Details

FWSimCache

public FWSimCache(LinkedHashMap<String,FWSimVariable<?>> aHeaderVariables,
 FWSimIOAdapter.FREQUENCE aFrequence,
 String aName,
 int aOrderNumber)

constructor from different media types in the fitting structure also used by transformers

Parameters:

aHeaderVariables -

aFrequence -

aName -

aOrderNumber -

FWSimCache

protected FWSimCache(int aFieldcount,
 String aName,
 HashMap<Object,Object[]> aCache,
 boolean aArrayMode,
 LinkedHashMap<String,FWSimVariable<?>> aHeaderVariables,
 FWSimIOAdapter.FREQUENCE aFrequence,
 int aOrderNumber,
 HashMap<String,Integer> aVariableIndex)

Parameters:

aFieldcount -

aName -

aCache -

aArrayMode -

aHeaderVariables -

aFrequence -

aOrderNumber -

aVariableIndex -

Method Details

getName

public String getName()

Specified by:

getName in interface FWSimFieldContainer

Returns:

the name

getFieldcount

public int getFieldcount()

Returns:

the fieldcount

isArrayMode

public boolean isArrayMode()

Returns:

the arrayMode

createVariables

public HashMap<String,FWSimVariable<?>> createVariables()

Specified by:

createVariables in interface FWSimFieldContainer

Returns:

variables from the field map

See Also:

• FWSimFieldContainer.createVariables()

getCache

public HashMap<Object,Object[]> getCache()

Returns:

the whole data content within the object[]

addVariable

public void addVariable(FWSimVariable<?> aVariable)

use this method with care - data has to be synchronized with the HeaderVariables

Specified by:

addVariable in interface FWSimFieldContainer

Parameters:

aVariable -

See Also:

• FWSimFieldContainer.addVariable(net.simplace.sim.util.FWSimVariable)

getVariable

public FWSimVariable<?> getVariable(String aID)

Specified by:

getVariable in interface FWSimFieldContainer

Parameters:

aID -

Returns:

FWSimVariable for ID in Field Map

See Also:

• FWSimFieldContainer.getVariable(java.lang.String)

getVariables

public HashMap<String,FWSimVariable<?>> getVariables()

Returns:

the Header Variables

See Also:

• FWSimFieldContainer.getVariable(java.lang.String)

removeVariable

public void removeVariable(String aID)

use this method with care - data has to be synchronized with the HeaderVariables

Specified by:

removeVariable in interface FWSimFieldContainer

Parameters:

aID -

See Also:

• FWSimFieldContainer.removeVariable(java.lang.String)

getOutputVariables

public Collection<FWSimVariable<?>> getOutputVariables()

delivers a list from the header information

Specified by:

getOutputVariables in interface FWSimFieldContainer

Returns:

FWSimVarables filtered - only output Variables

See Also:

• FWSimFieldContainer.getOutputVariables()

getOrderNumber

public int getOrderNumber()

Specified by:

getOrderNumber in interface FWSimFieldContainer

Returns:

number in the order of Components

See Also:

• FWSimFieldContainer.getOrderNumber()

getInputVariables

public Collection<FWSimVariable<?>> getInputVariables()

returned list will always be empty! Resources have not input fields

Specified by:

getInputVariables in interface FWSimFieldContainer

Returns:

FWSimVarables filtered - only input Variables

See Also:

• FWSimFieldContainer.getInputVariables()

getFieldMap

public LinkedHashMap<String,FWSimVariable<?>> getFieldMap()

taken from the HeaderVariables

Specified by:

getFieldMap in interface FWSimFieldContainer

Returns:

whole field map as created in createVariables()

See Also:

• FWSimFieldContainer.getFieldMap()

setCacheMap

public void setCacheMap(HashMap<Object,Object[]> aNewFieldMap)

setting complete new data structure

Parameters:

aNewFieldMap -

getContentType

public FWSimVariable.CONTENT_TYPE getContentType()

Specified by:

getContentType in interface FWSimFieldContainer

Returns:

number in the order of Components

See Also:

• FWSimFieldContainer.getContentType()

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Specified by:

getFrequence in interface FWSimFieldContainer

Returns:

the Frequence of the Container calling

See Also:

• FWSimFieldContainer.getFrequence()

getVariableIndex

public Integer getVariableIndex(String aFieldName)

Parameters:

aFieldName -

Returns:

the variable index

checkCondition

public void checkCondition(Boolean aCheckResult,
 String aMessage)

Description copied from interface: FWSimFieldContainer

Called from inside the FWSimFieldContainer to log the initialization Errors.

Specified by:

checkCondition in interface FWSimFieldContainer

Parameters:

aCheckResult -

aMessage -

isConditionCheck

public boolean isConditionCheck()

Specified by:

isConditionCheck in interface FWSimFieldContainer