com.interpss.dstab.cache

Class StateVariableRecorder

java.lang.Object

com.interpss.dstab.cache.base.BaseRecorder<StateVariableRecorder.StateRecord>

com.interpss.dstab.cache.StateVariableRecorder

All Implemented Interfaces:

IpssMsgListener, IDStabSimuOutputHandler, java.util.EventListener

public class StateVariableRecorder
extends BaseRecorder<StateVariableRecorder.StateRecord>
implements IDStabSimuOutputHandler

data structure for storing state change record for testing purpose. It is first seeded with a set of know values of multiple state variables. Then during the dynamic simulation process, it records the corresponding state value. The end, measured values could be compared with the seeded values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateVariableRecorder.StateRecord data record for storing state in the dynamic simulation process.
static class	StateVariableRecorder.StateVarRecType

Field Summary

Fields inherited from class com.interpss.dstab.cache.base.BaseRecorder

recordList, timeTolerance

Constructor Summary

Constructors

Constructor and Description
StateVariableRecorder(double timeTolerance)

Method Summary

Modifier and Type	Method and Description
void	addCacheRecords(java.lang.String id, StateVariableRecorder.StateVarRecType type, java.lang.String vname, double timeStep, int points) Add a set of time points and expected values for testing purpose.
void	addTestRecords(java.lang.String id, StateVariableRecorder.StateVarRecType type, java.lang.String vname, double[] tPoints, double[] expectedValues) Add a set of time points and expected values for testing purpose.
boolean	close() Will be called after the simulation for scripted output
double	diffTotal(java.lang.String id, StateVariableRecorder.StateVarRecType type, java.lang.String vname) Compare the seeded variable value with the measured
java.util.List<StateVariableRecorder.StateRecord>	getBusRecords(java.lang.String busId, StateVariableRecorder.StateVarRecType type, java.lang.String vname) get bus record
java.util.List<StateVariableRecorder.StateRecord>	getMachineRecords(java.lang.String machId, StateVariableRecorder.StateVarRecType type, java.lang.String vname) Get machine state records
java.util.List<java.lang.String>	getOutputVarIdList() get output var id list
boolean	init(java.lang.String scriptFilename, BaseDStabNetwork<?,?> net) Init with the script file name for scripted output
static boolean	isBusRec(StateVariableRecorder.StateVarRecType type) check the var type is a bus state record
static boolean	isMachineRec(StateVariableRecorder.StateVarRecType type) check if the var type is a machine state record
boolean	isOutputFilter() Check if there is an output variable filter
boolean	onMsgEventStatus(IpssMessage event) Record the simulation results
void	setOutputFilter(boolean b) Set output filter status
void	setOutputVarIdList(java.lang.String[] list) Set output var id list
static java.lang.String	type2String(StateVariableRecorder.StateVarRecType type) function to convert state var record type to string

Methods inherited from class com.interpss.dstab.cache.base.BaseRecorder

addTestRecord, onMsgEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.interpss.common.msg.IpssMsgListener

onMsgEvent

Constructor Detail

StateVariableRecorder

public StateVariableRecorder(double timeTolerance)

Method Detail

addTestRecords

public void addTestRecords(java.lang.String id,
                           StateVariableRecorder.StateVarRecType type,
                           java.lang.String vname,
                           double[] tPoints,
                           double[] expectedValues)

Add a set of time points and expected values for testing purpose. The combination of id + type + vname define the state var to be recorded

Parameters:

id - id of time simulation record, for example, "Mach@0001"

type -

vname - state vartable name, for example, DStabOutSymbol.OUT_SYMBOL_MACH_ANG

tPoints -

expectedValues -

addCacheRecords

public void addCacheRecords(java.lang.String id,
                            StateVariableRecorder.StateVarRecType type,
                            java.lang.String vname,
                            double timeStep,
                            int points)

Add a set of time points and expected values for testing purpose. The combination of id + type + vname define the state var to be recorded

Parameters:

id -

type -

vname -

timeStep -

points -

getMachineRecords

public java.util.List<StateVariableRecorder.StateRecord> getMachineRecords(java.lang.String machId,
                                                                           StateVariableRecorder.StateVarRecType type,
                                                                           java.lang.String vname)

Get machine state records

Parameters:

machId -

type -

vname -

Returns:

getBusRecords

public java.util.List<StateVariableRecorder.StateRecord> getBusRecords(java.lang.String busId,
                                                                       StateVariableRecorder.StateVarRecType type,
                                                                       java.lang.String vname)

get bus record

Parameters:

busId -

type -

vname -

Returns:

onMsgEventStatus

public boolean onMsgEventStatus(IpssMessage event)

Record the simulation results

Specified by:

onMsgEventStatus in interface IpssMsgListener

Overrides:

onMsgEventStatus in class BaseRecorder<StateVariableRecorder.StateRecord>

Parameters:

event - msg

Returns:

true/false

diffTotal

public double diffTotal(java.lang.String id,
                        StateVariableRecorder.StateVarRecType type,
                        java.lang.String vname)

Compare the seeded variable value with the measured

Parameters:

id - machine or bus id

type - state variable type

vname - state variable name

Returns:

type2String

public static java.lang.String type2String(StateVariableRecorder.StateVarRecType type)

function to convert state var record type to string

Parameters:

type -

Returns:

isMachineRec

public static boolean isMachineRec(StateVariableRecorder.StateVarRecType type)

check if the var type is a machine state record

Parameters:

type -

Returns:

isBusRec

public static boolean isBusRec(StateVariableRecorder.StateVarRecType type)

check the var type is a bus state record

Parameters:

type -

Returns:

close

public boolean close()

Description copied from interface: IDStabSimuOutputHandler

Will be called after the simulation for scripted output

Specified by:

close in interface IDStabSimuOutputHandler

Returns:

init

public boolean init(java.lang.String scriptFilename,
                    BaseDStabNetwork<?,?> net)

Description copied from interface: IDStabSimuOutputHandler

Init with the script file name for scripted output

Specified by:

init in interface IDStabSimuOutputHandler

getOutputVarIdList

public java.util.List<java.lang.String> getOutputVarIdList()

Description copied from interface: IDStabSimuOutputHandler

get output var id list

Specified by:

getOutputVarIdList in interface IDStabSimuOutputHandler

Returns:

setOutputVarIdList

public void setOutputVarIdList(java.lang.String[] list)

Description copied from interface: IDStabSimuOutputHandler

Set output var id list

Specified by:

setOutputVarIdList in interface IDStabSimuOutputHandler

isOutputFilter

public boolean isOutputFilter()

Description copied from interface: IDStabSimuOutputHandler

Check if there is an output variable filter

Specified by:

isOutputFilter in interface IDStabSimuOutputHandler

Returns:

setOutputFilter

public void setOutputFilter(boolean b)

Description copied from interface: IDStabSimuOutputHandler

Set output filter status

Specified by:

setOutputFilter in interface IDStabSimuOutputHandler