com.ergotech.secs

Class JSONEncodeDecode

java.lang.Object

com.ergotech.secs.JSONEncodeDecode

public abstract class JSONEncodeDecode
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JSONEncodeDecode()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	alarmToJSON(AlarmValues alarmValues, java.lang.String timeStamp) Encode an alarm report as a JSON message.
static SecsFormat	currentValue(GemHostModel.GemValueVariable vidValue) Return a valid SecsFormat representing the value in the provided value object.
static java.util.Map<java.lang.String,java.lang.String>	decodeDVVALs(java.lang.String jsonStr) Decode the given string as a SecsFormat00 { "values":[{ dvid:WaferCount, dvval:15 }, { dvid:23456, dvval:\"Hello World\" }] }
static java.util.Map<java.lang.String,SecsFormat>	decodeMessage(java.lang.String jsonStr) Decode the given string as a JSON Message format, eg.
static SecsFormat	decodeSecsFormat(JSONObject jsonObject)
static SecsFormat00	decodeSecsFormat00(java.lang.String jsonStr) Decode the given string as a SecsFormat00
static java.lang.String	eventMessageToJSON(GemToolModelSnapshot.GemReportVariable ceidVariable, java.util.List<ReportValues> reportValues, java.lang.String timeStamp) Encode an event message to JSON.
static java.lang.String	reportToJSON(ReportValues rptidVariable, java.lang.String timeStamp) Encode a report to a JSON Object.
static java.lang.String	secsFormat00ToJSON(SecsFormat00 secsFormat00) Encode a SecsFormat00 to a JSON Object.
static java.lang.String	secsFormatToJSON(SecsFormat secsFormat) Encode a SecsFormat to a JSON Object.
static java.lang.String	secsFormatType(SecsFormat secsFormat) Return a string representing the type of the SecsFormat.
static java.lang.String	traceToJSON(GemHostModel.GemTraceVariable traceVariable, java.util.List<GemHostModel.GemValueVariable> vidValues, java.lang.String timeStamp) Encode a trace to a JSON Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONEncodeDecode

public JSONEncodeDecode()

Method Detail

alarmToJSON

public static java.lang.String alarmToJSON(AlarmValues alarmValues,
                                           java.lang.String timeStamp)

Encode an alarm report as a JSON message. The format will be : {"alid":"1002", "altx":"Test", "alcd":"2", "action":"set" timestamp:"2019-02-12 14:29:13.306" }

Parameters:

rptidVariable - the report variable that is being encoded to JSON

timeStamp - the date/time in the format "yyyy-MM-dd HH:mm:ss.zzz". If this variable is null it will not be included in the JSON

Returns:

the JSON string representing the report variable

currentValue

public static SecsFormat currentValue(GemHostModel.GemValueVariable vidValue)

Return a valid SecsFormat representing the value in the provided value object. This will be the current value if valid otherwise it be a zero-length SecsFormat of the type indicated by the value type of the object.

Parameters:

vidValue - the value object from which the SecsFormat value will be extracted

Returns:

a valid SecsFormat. The current value, or a zero length value of the configured value type.

decodeDVVALs

public static java.util.Map<java.lang.String,java.lang.String> decodeDVVALs(java.lang.String jsonStr)
                                                                     throws VIBUpdateFailedException

Decode the given string as a SecsFormat00 { "values":[{ dvid:WaferCount, dvval:15 }, { dvid:23456, dvval:\"Hello World\" }] }

Parameters:

jsonString - the string representing the map of dvid and dvvals

Returns:

the Map of dvids and dvvals represented by the string. The ids and values are maintained as strings. The ReportWriter will cooerce to the correct types

Throws:

VIBUpdateFailedException

decodeMessage

public static java.util.Map<java.lang.String,SecsFormat> decodeMessage(java.lang.String jsonStr)
                                                                throws VIBUpdateFailedException

Decode the given string as a JSON Message format, eg. { "AllParams": { "values": [ { "value":"START", "type":20 }, { "values": [ { "values": [ "PPID","something" ] , "type":20 } ] } ] }, "Command": { "value":"START", "type":20 }, "CPValue": { "value":"something", "type":20 } }

Parameters:

jsonString - the string representing the map of dvid and dvvals

Returns:

the map of element names to SecsFormats

Throws:

VIBUpdateFailedException

decodeSecsFormat

public static SecsFormat decodeSecsFormat(JSONObject jsonObject)
                                   throws VIBUpdateFailedException

Throws:

VIBUpdateFailedException

decodeSecsFormat00

public static SecsFormat00 decodeSecsFormat00(java.lang.String jsonStr)
                                       throws VIBUpdateFailedException

Decode the given string as a SecsFormat00

Parameters:

jsonString - the string representing the SecsFormat00

Returns:

the SecsFormat00 represented by the string

Throws:

VIBUpdateFailedException

eventMessageToJSON

public static java.lang.String eventMessageToJSON(GemToolModelSnapshot.GemReportVariable ceidVariable,
                                                  java.util.List<ReportValues> reportValues,
                                                  java.lang.String timeStamp)

Encode an event message to JSON. This is mostly the list of reports. The format will be : {"eventname":[ {"reportName":[ {"GasFlow":"1.2", "type":34}, {"AString":"Test", "type":20}, {"BinarValues":[5,6,7,8], "type":10}, {"WaferCount":"15", "type":54}]} ], ceid:1003, timestamp:"2019-02-12 14:29:13.306" }

Parameters:

rptidVariable - the report variable that is being encoded to JSON

timeStamp - the date/time in the format "yyyy-MM-dd HH:mm:ss.zzz". If this variable is null it will not be included in the JSON

Returns:

the JSON string representing the report variable

reportToJSON

public static java.lang.String reportToJSON(ReportValues rptidVariable,
                                            java.lang.String timeStamp)

Encode a report to a JSON Object. The format will be : {"reportName":[ {"GasFlow":"1.2", "type":34}, {"AString":"Test", "type":20}, {"BinarValues":[5,6,7,8], "type":10}, {"WaferCount":"15", "type":54} ] rptid=109 timestamp:"2019-02-12 14:29:13.306" }

Parameters:

rptidVariable - the report variable that is being encoded to JSON

timeStamp - the date/time in the format "yyyy-MM-dd HH:mm:ss.zzz". If this variable is null it will not be included in the JSON

Returns:

the JSON string representing the report variable

secsFormat00ToJSON

public static java.lang.String secsFormat00ToJSON(SecsFormat00 secsFormat00)

Encode a SecsFormat00 to a JSON Object. There are two options. If all the types are the same, then the format will be { "values": [ "recipe1","recipe2", "recipe3", "recipe4"], type:"20" } { "values": [] } is also possible... If the types are different, then the structure will be: {"values":[ {"value":"1.2", "type":"34"}, {"value":"Test", "type":"20"}, {"value":[5,6,7,8], "type":"10"}, {"value":1, "type":"10"} ]}

secsFormatToJSON

public static java.lang.String secsFormatToJSON(SecsFormat secsFormat)

Encode a SecsFormat to a JSON Object. Output examples: {"value":"1.2", "type":"34"} {"value":"Test", "type":"20"} {"value":[5,6,7,8], "type":"10"} {"value":1, "type":"10"}

secsFormatType

public static java.lang.String secsFormatType(SecsFormat secsFormat)

Return a string representing the type of the SecsFormat. For example, SecsFormat34 will return "34".

Parameters:

secsFormat - the instance from which the type will be derived.

Returns:

the SecsFormat type, eg "20"

traceToJSON

public static java.lang.String traceToJSON(GemHostModel.GemTraceVariable traceVariable,
                                           java.util.List<GemHostModel.GemValueVariable> vidValues,
                                           java.lang.String timeStamp)

Encode a trace to a JSON Object. The format will be : {"traceName":[ {"GasFlow":"1.2", "type":34}, {"AString":"Test", "type":20}, {"BinarValues":[5,6,7,8], "type":10}, {"WaferCount":"15", "type":54} ] trid=109 timestamp:"2019-02-12 14:29:13.306" }

Parameters:

traceVariable - the trace variable that is being encoded to JSON

vidValues - the values from the trace data message

timeStamp - the date/time in the format "yyyy-MM-dd HH:mm:ss.zzz". If this variable is null it will not be included in the JSON

Returns:

the JSON string representing the report variable