com.ergotech.secs

Class Event

java.lang.Object

com.ergotech.secs.Event

public class Event
extends java.lang.Object

This object will store all the CEID's and what reports have been registered (and what they are)

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
boolean	CEIDExists(CEID theEvent)
int	defineReport(RPTID theRPTID, SecsFormat00 theVIDs) This will return true if the SecsFormat00 only contains VID's (the only value SecsFormat00)
int	defineReport(RPTID theRPTID, VID[] theVIDs)
int	defineReport(S2F33 msg) This is designed to take the format from a S2F33 message directly.
boolean	disableCEID(CEID theEvent)
int	enable_disableCEID(S2F37 msg)
boolean	enableCEID(CEID theEvent)
static S2F14	getECs(int session, S2F13 msg)
DATAID	getNextDataId()
S1F4	getSVs(S1F3 msg)
V	getV(int sessionId, VID theVID)
int	linkEvent(CEID theEvent, RPTID theReport)
int	linkEvent(S2F35 msg) This is expecting a SecsFormat00 with a DATAID and a SecsFormat of SecsFormat00's that containing two elements, the first element is a CEID and the second is is another SecsFormat00 full of only RPTID's.
void	registerCEID(CEID theEvent)
void	registerCEID(java.lang.String theEvent)
static ECV	registerECID(int session, ECID theId, ECV theECV)
SV	registerSVID(SVID theSVID, SV theSV) This will register a SV with a SVID.
V	registerVID(int sessionId, VID theVID, V theV) This will register a V with a VID.
static byte	setECs(int session, S2F15 msg)
void	setSessionManager(SessionManager newPort)
boolean	VIDExists(VID theVID)

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

CEIDExists

public boolean CEIDExists(CEID theEvent)

defineReport

public int defineReport(RPTID theRPTID,
                        SecsFormat00 theVIDs)

This will return true if the SecsFormat00 only contains VID's (the only value SecsFormat00)

defineReport

public int defineReport(RPTID theRPTID,
                        VID[] theVIDs)

defineReport

public int defineReport(S2F33 msg)

This is designed to take the format from a S2F33 message directly. Please look at your manual under S2F33 for full structure.

disableCEID

public boolean disableCEID(CEID theEvent)

enable_disableCEID

public int enable_disableCEID(S2F37 msg)

enableCEID

public boolean enableCEID(CEID theEvent)

getECs

public static S2F14 getECs(int session,
                           S2F13 msg)
                    throws SecsException

Throws:

SecsException

getNextDataId

public DATAID getNextDataId()

getSVs

public S1F4 getSVs(S1F3 msg)
            throws SecsException

Throws:

SecsException

getV

public V getV(int sessionId,
              VID theVID)

linkEvent

public int linkEvent(CEID theEvent,
                     RPTID theReport)

Returns:

This will return true if the report exists and the CEID has been registered, else it will return false.

linkEvent

public int linkEvent(S2F35 msg)

This is expecting a SecsFormat00 with a DATAID and a SecsFormat of SecsFormat00's that containing two elements, the first element is a CEID and the second is is another SecsFormat00 full of only RPTID's. For more information look in the S2F35 structure. This method was designed for this message.

registerCEID

public void registerCEID(CEID theEvent)

registerCEID

public void registerCEID(java.lang.String theEvent)

registerECID

public static ECV registerECID(int session,
                               ECID theId,
                               ECV theECV)

registerSVID

public SV registerSVID(SVID theSVID,
                       SV theSV)

This will register a SV with a SVID. It will return an old SV if one was already registered.

registerVID

public V registerVID(int sessionId,
                     VID theVID,
                     V theV)

This will register a V with a VID. This will return the old V that used to be registered for the VID if one existed.

setECs

public static byte setECs(int session,
                          S2F15 msg)
                   throws SecsException

Throws:

SecsException

setSessionManager

public void setSessionManager(SessionManager newPort)

VIDExists

public boolean VIDExists(VID theVID)