com.eurotech.framework.protocol.pcn
Interface Pcn1001MasterService

All Known Implementing Classes:
Pcn1001Master

public interface Pcn1001MasterService

Defines PCN-1001 master service.

Author:
ilya.binshtok

Field Summary
static String SERVICE_NAME
          name of this service
 
Method Summary
 Pcn1001CountInfoService[] enableDisablePcn1001Counting(byte enOpcode)
          Enables/disables counting on all functional devices.
 Pcn1001Service[] getAllFunctionalCounters(boolean verifyWithPoll)
          Sends SNP polls to all configured passenger counters and reports all functional units.
 Pcn1001AddressInfoService[] getPcn1001AddressInfo()
          Obtains and reports PCN-1001 address information from all functional devices.
 Pcn1001CountInfoService[] getPcn1001CountInfo()
          Obtains and reports PCN-1001 IN/OUT count information from all functional devices.
 Pcn1001InfoService[] getPcn1001Info()
          Obtains and reports PCN-1001 information from all functional devices.
 Pcn1001InputLineInfoService[] getPcn1001InputLineInfo()
          Obtains and reports PCN-1001 input line information from all functional devices.
 Pcn1001CountInfoService[] getPcn1001LastCountInfo()
          Returns last read CountInfo.
 Pcn1001MasterConfig getPcn1001MasterConfig()
          Reports PCN-1001 Master configuration.
 Pcn1001VersionInfoService[] getPcn1001VersionInfo()
          Obtains and reports PCN-1001 version information.
 boolean isPcn1001MasterReady()
          Reports id PCN-1001 master is ready.
 void registerListener(Pcn1001CountListenerService listener)
          registers a listener with the IPcn1001CountListener
 Pcn1001CountInfoService[] resetPcn1001Counts()
          Resets IN/OUT counts all functional devices.
 void setSnpChannelProperties(Properties snpProperties)
           
 void unregisterListener(Pcn1001CountListenerService listener)
          unregisters a listener with the IPcn1001CountListener
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
name of this service

Method Detail

setSnpChannelProperties

void setSnpChannelProperties(Properties snpProperties)

getPcn1001AddressInfo

Pcn1001AddressInfoService[] getPcn1001AddressInfo()
                                                  throws EsfException
Obtains and reports PCN-1001 address information from all functional devices.

Returns:
PCN-1001 address information as IPcn1001AddressInfoService[]
Throws:
EsfException

getPcn1001CountInfo

Pcn1001CountInfoService[] getPcn1001CountInfo()
Obtains and reports PCN-1001 IN/OUT count information from all functional devices.

Returns:
PCN-1001 IN/OUT count information as IPcn1001CountInfoService[]

getPcn1001LastCountInfo

Pcn1001CountInfoService[] getPcn1001LastCountInfo()
Returns last read CountInfo.

Returns:

getPcn1001InputLineInfo

Pcn1001InputLineInfoService[] getPcn1001InputLineInfo()
Obtains and reports PCN-1001 input line information from all functional devices.

Returns:
PCN-1001 input line information as IPcn1001InputLineInfoService[]

getPcn1001VersionInfo

Pcn1001VersionInfoService[] getPcn1001VersionInfo()
Obtains and reports PCN-1001 version information.

Returns:
PCN-1001 version information as IPcn1001VersionInfoService[]

getPcn1001Info

Pcn1001InfoService[] getPcn1001Info()
Obtains and reports PCN-1001 information from all functional devices.

Returns:
PCN-1001 information as IPcn1001InfoService[]

resetPcn1001Counts

Pcn1001CountInfoService[] resetPcn1001Counts()
Resets IN/OUT counts all functional devices.

Returns:
PCN-1001 IN/OUT count information after reset as IPcn1001CountInfoService[]

enableDisablePcn1001Counting

Pcn1001CountInfoService[] enableDisablePcn1001Counting(byte enOpcode)
Enables/disables counting on all functional devices.

Parameters:
enOpcode - - enable/disable opcode as byte
Returns:
PCN-1001 IN/OUT count information after reset as IPcn1001CountInfoService[]

isPcn1001MasterReady

boolean isPcn1001MasterReady()
Reports id PCN-1001 master is ready.

Returns:
boolean

registerListener

void registerListener(Pcn1001CountListenerService listener)
registers a listener with the IPcn1001CountListener

Parameters:
listener - the IPcn1001CountListener to register

unregisterListener

void unregisterListener(Pcn1001CountListenerService listener)
unregisters a listener with the IPcn1001CountListener

Parameters:
listener - the IPcn1001CountListener to unregister

getAllFunctionalCounters

Pcn1001Service[] getAllFunctionalCounters(boolean verifyWithPoll)
                                          throws EsfException
Sends SNP polls to all configured passenger counters and reports all functional units.

Parameters:
verifyWithPoll - - verify functionality with SNP poll as boolean
Returns:
an array of functional PCN-1001 objects as IPcn1001Service[]
Throws:
EsfException

getPcn1001MasterConfig

Pcn1001MasterConfig getPcn1001MasterConfig()
Reports PCN-1001 Master configuration.

Returns:
PCN-1001 Master configuration as Pcn1001MasterConfig


Copyright © 2013. All Rights Reserved.