com.isti.trinetwatch.collectionAgentSim

Class StationInfo

java.lang.Object

com.isti.trinetwatch.collectionAgentSim.StationInfo

public class StationInfo
extends java.lang.Object

This method creates a data structure that holds information about a given station.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	sendDPsFlag

Constructor Summary

Constructors

Constructor and Description
StationInfo(java.lang.String stationName) Creates an instance of type StationInfo.

Method Summary

Modifier and Type	Method and Description
boolean	addStaticParam(StationStaticParam sParam) Used to add a new static parameter to this station.
boolean	addStaticParam(java.lang.String name, java.lang.String data) Used to add a new static parameter to this station.
StationDynamicParam	getDynamicParam(java.lang.String paramName) Use this method to get a handle on the requested dynamic parameters object.
java.util.Enumeration	getDynamicParamsEnum() Use this method to get an enumeration of all the dynamic parameters for this station.
java.lang.String	getName() Used to get the Name of the station.
StationStaticParam	getStaticParam(java.lang.String paramName) Use this method to get a handle to the given static parameter
java.util.Enumeration	getStaticParamsEnum() Use this method to get an enumeration of all the static parameters in this station.
boolean	updateDynamicParam(java.lang.String name, java.lang.String data) Used to create and update a given dynamic parameter.

Methods inherited from class java.lang.Object

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

Field Detail

sendDPsFlag

public boolean sendDPsFlag

Constructor Detail

StationInfo

public StationInfo(java.lang.String stationName)

Creates an instance of type StationInfo.

Parameters:

stationName - A string containing the name of the station.

Method Detail

addStaticParam

public boolean addStaticParam(java.lang.String name,
                              java.lang.String data)

Used to add a new static parameter to this station.

Parameters:

name - A string containing the name of the parameter.

data - A string containing the data for the parameter.

Returns:

True if added correctly; false if a param is null or length 0, or if a parameter already exists by the given name.

addStaticParam

public boolean addStaticParam(StationStaticParam sParam)

Used to add a new static parameter to this station.

Parameters:

sParam - A StationStaticParam object.

Returns:

True if correctly done; false if the param is null or a station

getStaticParam

public StationStaticParam getStaticParam(java.lang.String paramName)

Use this method to get a handle to the given static parameter

Parameters:

paramName - The name of the desired static parameter.

Returns:

A handle to the requested StationStaticParam object or null if no object is associated with the given name or the object is not of type StationStaticParam.

getStaticParamsEnum

public java.util.Enumeration getStaticParamsEnum()

Use this method to get an enumeration of all the static parameters in this station.

Returns:

An enumeration of all the static parameters in this station.

getName

public java.lang.String getName()

Used to get the Name of the station.

Returns:

A string containing the name of the station.

updateDynamicParam

public boolean updateDynamicParam(java.lang.String name,
                                  java.lang.String data)

Used to create and update a given dynamic parameter.

Parameters:

name - A string containing the name of the parameter.

data - A java object containing the parameters' data.

Returns:

True if correctly updated; false if a parameter is null, or if the param name is length 0.

getDynamicParam

public StationDynamicParam getDynamicParam(java.lang.String paramName)

Use this method to get a handle on the requested dynamic parameters object.

Parameters:

paramName - A string holding the name of the parameter

Returns:

A handle to the StationDynamicParam object requested or null if no object is associated with this name or it is not of type StationDynamicParam.

getDynamicParamsEnum

public java.util.Enumeration getDynamicParamsEnum()

Use this method to get an enumeration of all the dynamic parameters for this station.

Returns:

An enumeration of all the StationDynamicParam objects associated with this station.