jpwr.rt
Class Mh

java.lang.Object
  |
  +--jpwr.rt.Mh

public class Mh

extends java.lang.Object

Description of the Class

Constructor Summary

Mh(java.lang.Object root)
Constructor for the Mh object

Method Summary

int	checkUser() Description of the Method
void	close() Description of the Method
jpwr.rt.PwrtStatus	createInstanceFile(java.lang.String from, java.lang.String to, java.lang.String instance) Description of the Method
java.lang.String	getUser() Gets the user attribute of the Mh object
boolean	isAuthorized(int access) Gets the authorized attribute of the Mh object
int	login(java.lang.String user, java.lang.String password) Description of the Method
void	logout() Description of the Method
void	logString(java.lang.String str) Description of the Method
void	messReceived(int messType, java.lang.String messString) Anropas av Callbackfunktionerna
java.lang.String	newMess() Väntar på att ett nytt meddelande skall komma
jpwr.rt.PwrtStatus	outunitAck(jpwr.rt.MhsEventId alarmId) Se Programmers reference manual för beskrivning
jpwr.rt.PwrtStatus	outunitBlock(jpwr.rt.PwrtObjid object, jpwr.rt.MheEventPrio prio) Se Programmers reference manual för beskrivning
jpwr.rt.PwrtStatus	outunitConnect(jpwr.rt.PwrtObjid outunit) Kopplar en outunit till den lokala meddelandehanteraren
jpwr.rt.PwrtStatus	outunitDisConnect() Kopplar bort en outunit från den lokala meddelandehanteraren
jpwr.rt.PwrtStatus	outunitReceive() Den här funktionen läser meddelandekön för en outunit.
jpwr.rt.PwrtStatus	outunitUnBlock(jpwr.rt.PwrtObjid object) Se Programmers reference manual för beskrivning
jpwr.rt.PwrtStatus	outunitUpdate() Se Programmers reference manual för beskrivning
void	printStatistics(int lockRejected) Description of the Method
static java.lang.String	translateFilename(java.lang.String filename) Description of the Method

Methods inherited from class java.lang.Object

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

Constructor Detail

Mh

public Mh(java.lang.Object root)

Constructor for the Mh object

Parameters:

root - Description of the Parameter

Method Detail

close

public void close()

Description of the Method

printStatistics

public void printStatistics(int lockRejected)

Description of the Method

Parameters:

lockRejected - Description of the Parameter

login

public int login(java.lang.String user,
                 java.lang.String password)

Description of the Method

Parameters:

user - Description of the Parameter

password - Description of the Parameter

Returns:

Description of the Return Value

logout

public void logout()

Description of the Method

checkUser

public int checkUser()

Description of the Method

Returns:

Description of the Return Value

getUser

public java.lang.String getUser()

Gets the user attribute of the Mh object

Returns:

The user value

isAuthorized

public boolean isAuthorized(int access)

Gets the authorized attribute of the Mh object

Parameters:

access - Description of the Parameter

Returns:

The authorized value

createInstanceFile

public jpwr.rt.PwrtStatus createInstanceFile(java.lang.String from,
                                             java.lang.String to,
                                             java.lang.String instance)

Description of the Method

Parameters:

from - Description of the Parameter

to - Description of the Parameter

instance - Description of the Parameter

Returns:

Description of the Return Value

logString

public void logString(java.lang.String str)

Description of the Method

Parameters:

str - Description of the Parameter

messReceived

public void messReceived(int messType,
                         java.lang.String messString)

Anropas av Callbackfunktionerna

Parameters:

messType - Meddelandetyp

messString - Meddelande

newMess

public java.lang.String newMess()

Väntar på att ett nytt meddelande skall komma

Returns:

Description of the Return Value

outunitAck

public jpwr.rt.PwrtStatus outunitAck(jpwr.rt.MhsEventId alarmId)

Se Programmers reference manual för beskrivning

Parameters:

alarmId - Identiteten av för larmet som skall kvitteras

Returns:

Status. Koder: %MH-S-SUCCES, %MH-S-ACKBUFF larmkvittensen buffrades lokalt

outunitBlock

public jpwr.rt.PwrtStatus outunitBlock(jpwr.rt.PwrtObjid object,
                                       jpwr.rt.MheEventPrio prio)

Se Programmers reference manual för beskrivning

Parameters:

object - Identiteten för objektet som skall blockeras

prio - Prioriteten som skall blockeras

Returns:

Status. Koder: %MH-S-SUCCES, %MH-W-BLOCKED redan blockerad med samma prioritet, %GDH-F-NOSUCHOBJ objektet är inte tillgängligt

outunitConnect

public jpwr.rt.PwrtStatus outunitConnect(jpwr.rt.PwrtObjid outunit)

Kopplar en outunit till den lokala meddelandehanteraren

Parameters:

outunit - Objektsidentiteten för UserObjektet

Returns:

Status. Koder: %MH-S-SUCCES

outunitDisConnect

public jpwr.rt.PwrtStatus outunitDisConnect()

Kopplar bort en outunit från den lokala meddelandehanteraren

Returns:

Status. Koder: %MH-S-SUCCES

outunitReceive

public jpwr.rt.PwrtStatus outunitReceive()

Den här funktionen läser meddelandekön för en outunit. Om det finns ett meddelande kommer messReceived att anropas

Returns:

Status. Koder: %MH-S-SUCCES

outunitUnBlock

public jpwr.rt.PwrtStatus outunitUnBlock(jpwr.rt.PwrtObjid object)

Se Programmers reference manual för beskrivning

Parameters:

object - Identiteten för objektet som skall blockeras

Returns:

Status. Koder: %MH-S-SUCCES, %MH-W-NOTBLOCK redan avblockerad , %GDH-F-NOSUCHOBJ objektet är inte tillgängligt

outunitUpdate

public jpwr.rt.PwrtStatus outunitUpdate()

Se Programmers reference manual för beskrivning

Returns:

Status. Koder: %MH-S-SUCCES

translateFilename

public static java.lang.String translateFilename(java.lang.String filename)

Description of the Method

Parameters:

filename - Description of the Parameter

Returns:

Description of the Return Value