de.stz.bt.fnd.FND_Datagram Class Reference

List of all members.

Public Member Functions
void	setLen (byte len)
byte	getLen ()
void	setTransportControl (byte d_r, byte tag, byte mpr, byte seg) throws IndexOutOfBoundsException
byte[]	getTransportControl ()
void	setSegmentNr (byte segNr)
byte	getSegmentNr ()
void	setInvokeID (byte invokeID)
byte	getInvokeID ()
void	setCentralControl (byte centralControlID, byte centralControlSubID)
byte[]	getCentralControl ()
void	setIslandControl (byte islandControlID, byte islandControlSubID)
byte[]	getIslandControl ()
void	setDataPointID (byte[] dataPointID) throws IndexOutOfBoundsException
byte[]	getDataPointID ()
void	setOperationsCode (byte fct_id, byte tab_id, byte dp_type, byte dp_subtype) throws IndexOutOfBoundsException
byte[]	getOperationsCode ()
void	setApplicationControl (byte prd, byte rpr, byte emq) throws IndexOutOfBoundsException
byte[]	getApplicationControl ()
void	setMask (byte val, byte apr, byte mis, byte msk) throws IndexOutOfBoundsException
byte[]	getMask ()
void	setInfoEvent (byte info, byte event) throws IndexOutOfBoundsException
byte[]	getInfoEvent ()
boolean[]	getInfoEventBits ()
void	setInfoCode (byte exc_1, byte exc_2)
byte[]	getInfoCode ()
void	setDateTime (byte year, byte month, byte day, byte hour, byte minute, byte second) throws IndexOutOfBoundsException
byte[]	getDateTime ()
void	setDataPart (byte[] data) throws IndexOutOfBoundsException
byte[]	getDataPart ()
byte[]	getFndDatagramByteArray ()
FND_DataPointContext	getContext ()
void	setContext (FND_DataPointContext context)
byte[]	getDatagramHeader ()
byte	getDatapointType ()
void	setDatapointType (byte dpointtype)
byte	getDatagramSegmentType ()
void	setDatagramSegmentType (byte dgramsegtype)
byte	getDatagramTag ()
void	setDatagramTag (byte dgramattr)
byte	getDatagramType ()
void	setDatagramType (byte dgramtype)
int	getProtocolVersion ()
InetAddress	getSender ()
void	setSender (InetAddress address)
Static Public Attributes
final int	FND10 = 0xF0
final int	FND20 = 0xF1
final byte	TAG_NORMAL = 0
final byte	TAG_REJECT = 1
final byte	TAG_ERROR = 2
final byte	D_R_CMD = 0
final byte	D_R_RSP = 3
final byte	D_R_USM = 2
final byte	D_R_ACK = 1
final byte	MPR_NORMAL = 0
final byte	MPR_IMPORTANT = 1
final byte	MPR_HIGH = 2
final byte	MPR_URGENT = 3
final byte	SEG_NO = 0
final byte	SEG_FIRST = 3
final byte	SEG_NEXT = 2
final byte	SEG_LAST = 1
final byte	IMPLICIT_FCT = 0
final byte	READ_FCT = 1
final byte	MODIFY_FCT = 2
final byte	DP_TAB_0 = 0
final byte	DP_TAB_1 = 1
final byte	DP_TAB_2 = 2
final byte	DP_TAB_1_2 = 3
Package Attributes
FND_DataPointContext	context = null
InetAddress	sender = null
byte[]	data = null
int	dataLen = 0

---

Detailed Description

Object Oriented representation of a FND-Datagram.

Author:

Lars Heineken

J. Seitter

Version:

Id

FND_Datagram.java,v 1.5 2004/11/12 09:08:18 jseitter Exp

---

Member Function Documentation

byte [] de.stz.bt.fnd.FND_Datagram.getApplicationControl (   )

Returns applicationControl. See also: FND_Datagram.setApplicationControl (byte id, byte rights, byte mec) Returns: applicationControl[] applicationControl[0] = prd applicationControl[1] = rpr applicationControl[2] = emq { // For explanation and an example what's happening here see // getTransportControl() byte[] applicationControl = {(byte) ((data[27] & 0xC0) >>> 6), // id (byte) ((data[27] & 0x30) >>> 4), // rights (byte) ((data[27] & 0x0F)) // mec }; return applicationControl; }

byte [] de.stz.bt.fnd.FND_Datagram.getCentralControl (   )

Returns CentralControlID and centralControlSubID. See also: FND_Datagram.setCentralControl(byte centralControlID, byte centralControlSubID) Returns: centralControl[] centralControl[0] = centralControlID centralControl[1] = centralControlSubID { byte[] centralControl = { data[5], data[6] }; return centralControl; }

FND_DataPointContext de.stz.bt.fnd.FND_Datagram.getContext (   )

Returns: The current context for this datapoint { return context; }

byte [] de.stz.bt.fnd.FND_Datagram.getDatagramHeader (   )

Returns: the datagram header part (mainly used by error datagrams) { //copy the header part of the datagram byte[] header = new byte[38]; for(int i=0; i<38; i++){ header[i]=this.data[i]; } return header; }

byte de.stz.bt.fnd.FND_Datagram.getDatagramTag (   )

Returns: the tag field of the datagram This field describes if this is an NORMAL, ERROR or REJECT datagram { // returns the tag field // it's used together with the constants return this.getTransportControl()[1]; }

byte [] de.stz.bt.fnd.FND_Datagram.getDataPart (   )

Returns DateTime. See also: FND_Datagram.setDataPart (byte[] data) Returns: dataPart[] dataPart[0] to dataPart[89] (maximum) { byte[] dataPart = new byte[data[1] - 36]; // space for dataPart (length-2-36) for (int i = 0; i < dataPart.length; i++) { dataPart[i] = data[38 + i]; } return dataPart; }

byte [] de.stz.bt.fnd.FND_Datagram.getDataPointID (   )

Returns dataPointID. See also: FND_Datagram.setDataPointID (byte[] dataPointID) Returns: dataPoint[] dataPointID[0] to dataPointID[15] = dataPointID. { byte[] dataPointID = new byte[16]; for (int i = 0; i < 16; ++i) { dataPointID[i] = data[i + 9]; // data[9] to [25] } return dataPointID; }

byte de.stz.bt.fnd.FND_Datagram.getDatapointType (   )

Returns: the dp_type field of the datagram { // returns the dp_type field already casted to int // it's used together with the constants return this.getOperationsCode()[2]; }

byte [] de.stz.bt.fnd.FND_Datagram.getDateTime (   )

Returns DateTime. See also: FND_Datagram.setDateTime (byte year, byte month, byte day, byte hour, byte minute, byte second) Returns: dateTime[] dateTime[0] = year dateTime[1] = month dateTime[2] = day dateTime[3] = hour dateTime[4] = minute dateTime[5] = second { byte[] dateTime = { (byte) (data[32]), (byte) (data[33]), (byte) (data[34]), (byte) (data[35]), (byte) (data[36]), (byte) (data[37])}; return dateTime; }

byte [] de.stz.bt.fnd.FND_Datagram.getFndDatagramByteArray (   )

Returns raw byte array of the FND_Datagram. This is needed for sending the FND_Datagram with i.e. UDP Returns: data[] { return data; }

byte [] de.stz.bt.fnd.FND_Datagram.getInfoCode (   )

Returns InfoCode. See also: FND_Datagram.setInfoCode (byte exc_1, byte exc_2) Returns: infoCode[] infoCode[0] = exc_1 infoCode[1] = exc_2 { // For an explanation and an example what's happening here, see // getTransportControl() byte[] infoCode = {(byte) (data[30]), (byte) (data[31])}; return infoCode; }

byte [] de.stz.bt.fnd.FND_Datagram.getInfoEvent (   )

Returns InfoEvent. See also: FND_Datagram.setInfoEvent (byte info, byte event) Returns: infoEvent[] infoEvent[0] = info infoEvent[1] = event { byte[] infoEvent = {(byte) ((data[29] & 0xF0) >>> 4), // info (byte) ((data[29] & 0x0F)) // event }; return infoEvent; }

boolean [] de.stz.bt.fnd.FND_Datagram.getInfoEventBits (   )

returns the InfoEvent field as an array of boolean values Returns: array of boolean representing bits 0..7 of InfoEvent byte { boolean[] infoEventBits = new boolean[8]; if((data[29] & 0x01)==1) {infoEventBits[0]=true;} else {infoEventBits[0]=false;} if(((data[29] & 0x02)>>>1)==1) {infoEventBits[1]=true;} else {infoEventBits[1]=false;} if(((data[29] & 0x04)>>>2)==1) {infoEventBits[2]=true;} else {infoEventBits[2]=false;} if(((data[29] & 0x08)>>>3)==1) {infoEventBits[3]=true;} else {infoEventBits[3]=false;} if(((data[29] & 0x10)>>>4)==1) {infoEventBits[4]=true;} else {infoEventBits[4]=false;} if(((data[29] & 0x20)>>>5)==1) {infoEventBits[5]=true;} else {infoEventBits[5]=false;} if(((data[29] & 0x40)>>>6)==1) {infoEventBits[6]=true;} else {infoEventBits[6]=false;} if(((data[29] & 0x80)>>>7)==1) {infoEventBits[7]=true;} else {infoEventBits[7]=false;} return infoEventBits; }

byte de.stz.bt.fnd.FND_Datagram.getInvokeID (   )

Returns Datagrams invoke ID. See also: FND_Datagram.setInvokeID(byte invokeID) Returns: Datagram's invoke ID. { return this.data[4]; }

byte [] de.stz.bt.fnd.FND_Datagram.getIslandControl (   )

Returns islandControlID and islandControlSubID. See also: FND_Datagram.setIslandControl(byte islandControlID, byte islandControlSubID) Returns: islandControlID[] islandControlID[0] = islandControlID islandControlID[1] = islandControlSubID { byte[] islandControl = { data[7], data[8] }; return islandControl; }

byte de.stz.bt.fnd.FND_Datagram.getLen (   )

See also: FND_Datagram.setLen(byte) Returns: lenght of FND_Datagram, in bytes, minus 2 . { return this.data[1]; }

byte [] de.stz.bt.fnd.FND_Datagram.getMask (   )

Returns Mask. See also: FND_Datagram.setMask (byte val, byte apr, byte mis, byte msk) Returns: mask[] mask[0] = val mask[1] = apr mask[2] = mis mask[3] = msk { // For an explanation and an example what's been done here, see // getTransportControl() byte[] mask = {(byte) ((data[28] & 0xC0) >>> 6), // val (2 bits) (byte) ((data[28] & 0x30) >>> 4), // apr (2 bits) (byte) ((data[28] & 0x0C) >>> 2), // mis (2 bits) (byte) ((data[28] & 0x03)) // msk (2 bits) }; return mask; }

byte [] de.stz.bt.fnd.FND_Datagram.getOperationsCode (   )

Returns operationsCode. See also: FND_Datagram.setOperationsCode (byte fct_id, byte tab_id, byte dp_type, byte dp_subtype) Returns: operationCode operationCode[0] = fct_id operationCode[1] = tab_id operationCode[2] = dp_type operationCode[3] = dp_subtype { // for an example and what's happening here, see getTransportControl() byte[] operationCode = {(byte) ((this.data[25] & 0xF0) >>> 4), // fct_id (byte) ((this.data[25] & 0x0F)), // tab_id (byte) ((this.data[26] & 0xF0) >>> 4), // dp_type (byte) ((this.data[26] & 0x0F)) // dp_subtype }; return operationCode; }

int de.stz.bt.fnd.FND_Datagram.getProtocolVersion (   )

Returns: the ProtocolVersion as an Integer ( 0xF0 for FND 1.0) { return (int) data[0]; }

byte de.stz.bt.fnd.FND_Datagram.getSegmentNr (   )

Returns Datagrams segment number. See also: FND_Datagram.setSegmentNr(byte segNr) Returns: Datagram's segment number. { return this.data[3]; }

InetAddress de.stz.bt.fnd.FND_Datagram.getSender (   )

Returns: the InetAddress Object of the socket receiving the datagram { return sender; }

byte [] de.stz.bt.fnd.FND_Datagram.getTransportControl (   )

Used to get the four values of the transport-control byte. See also: FND_Datagram.setTransportControl(byte d_r, byte tag, byte mpr, byte seg) Returns: transportControl[] transportControl[0] = d_r transportControl[1] = tag transportControl[2] = mpr transportControl[3] = seg { // masks out the values inside the transportControl byte (data[2]) and // builds a byte array. byte[] transportControl = {(byte) ((this.data[2] & 0xC0) >>> 6), //d_r (byte) ((this.data[2] & 0x30) >>> 4), // tag (byte) ((this.data[2] & 0x0C) >>> 2), // mpr (byte) (this.data[2] & 0x03) // seg }; // transportControl tag extraction (example): // transportControl 1011 0110 // 1011 0110 & 0x30 => 0011 0000 // 0011 0000 >>> 4 => 0000 0011 -> tag = 3 return transportControl; }

void de.stz.bt.fnd.FND_Datagram.setApplicationControl (  byte  prd, byte  rpr, byte  emq )  throws IndexOutOfBoundsException

These settings are used to implement acces rights and access priorities. If creating a datagram that does not alter DP_#1 or DP_#2, prd and rpr have to be 0. Same goes for USM-datgrams. Respond- and ACK-datagrams need to copy the values of prd and rpr ,without modifications, from the datagram that belongs to that Respond- or ACK-datagram. Parameters: prd  Identification. The higher the value, the more rights are assigned to the datagram. 0 = regular user 1 = privileged user 2 = super user 3 = administrator rpr  Access control. Sets the threshold that determines wich user is allowed to use the datapoint used by this datagram. 0 = regular user, priviledged user, super user and adiministrator has access rights to the datapoint 1 = priviledged user, super user and administrator has acces rights to the datapoint. 2 = super user and administrator has access rights to the datapoint. 3 = only administrator has access rights to the datapoint. emq  Event Modification Qualifier Has a different meaning, depending on wether the datagram is used as command or message. Command Mode: (Used as modification control) To be abled to modify only a small part of the whole DP-table, the four bits of this parameter can be set individually, to specify that only those DP-table entries are beeing modified who's bit is set to 1. The first bit (if set to 1) enables modification of the first DP-table entry The second bit (if set to 1) enables modification of the second DP-table entry ... The fourth bit (if set to 1) enables modification of the fourth DP-table entry. Message Mode: (Used to indicate the reason for a spontanious message) Seems like nonsense at first but in case the one reason for a sponatnious message is still there (a sensor malfunction for example) and a second reason for a spontanious message appears later, causing a second sponatnious message (a value has changed, for example), you need to specify wich reason caused the datagram. The second datagram would only set the emq-bit connected with the very reason of the spontanious message (the emq-bit connected to the event-bit for value changes, for example). The first bit (if set to 1) indicates the first bit of event (last four bits of the byte info_event) was the reason for the spontanious message. The second bit (if set to 1) indicates the second bit of event (last four bits of the byte info_event) was the reason for the spontanious message. ... The second bit (if set to 1) indicates the first bit of event (last four bits of the byte info_event) was the reason for the spontanious message. When creating an ACK-datagram the value must be copied from the REQ-datagram without any modifications. Exceptions: IndexOutOfBoundsException  In Case any of the supplied parameters exceeds its maximum value, this exception is thrown. { if (prd > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setApplicationControl() parameter id, above maximum, value=" + prd + "maximum value=3")); } if (rpr > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setApplicationControl() parameter rights, above maximum, value=" + rpr + "maximum value=3")); } if (emq > 15) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setApplicationControl() parameter mec, above maximum, value=" + emq + "maximum value=15")); } this.data[27] = prd; this.data[27] <<= 2; this.data[27] |= rpr; this.data[27] <<= 2; this.data[27] |= emq; }

void de.stz.bt.fnd.FND_Datagram.setCentralControl (  byte  centralControlID, byte  centralControlSubID )

This information is used to indentify the central control associated with the datagram Parameters: centralControlID  Used to indetify the central control. centralControlSubID  Optional ID (default 0), connects the datagram with a corresponding internal Process. { this.data[5] = centralControlID; this.data[6] = centralControlSubID; }

void de.stz.bt.fnd.FND_Datagram.setContext (  FND_DataPointContext  context  )

Parameters: context  an Context object that is responsible for working with this datapoint { this.context = context; }

void de.stz.bt.fnd.FND_Datagram.setDataPart (  byte[]  data  )  throws IndexOutOfBoundsException

Put raw byte data into the data-part of the FND_Datagram. Parameters: data  The raw data. Maximum length is 128-38 = 90 byte. Exceptions: IndexOutOfBoundsException  In case the array supplied is too large. { if (data.length > 90) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDataPart() parameter data, above maximum length, value=" + data.length + "maximum length=90")); } for (int i = 0; i < data.length; ++i) { this.data[38 + i] = data[i]; } }

void de.stz.bt.fnd.FND_Datagram.setDataPointID (  byte[]  dataPointID  )  throws IndexOutOfBoundsException

The DataPoint ID is a unique ID assigned to every datapoint. Parameters: dataPointID  The DataPoint ID to be assigned to the datagram Exceptions: IndexOutOfBoundsException  If the datapoint ID is too large (more than 16 charcters) this exception is thrown. { if (dataPointID.length > 16) { throw ( new IndexOutOfBoundsException("FND_Datagram.setDataPointID: dataPointID too large (too many characters")); } System.arraycopy(dataPointID, 0, data, 9, dataPointID.length); // If the dataPointID is shorter than 16 characters, zeros are added. for (int i = dataPointID.length; i <= 16; ++i) { this.data[9 + dataPointID.length] = 0; } }

void de.stz.bt.fnd.FND_Datagram.setDatapointType (  byte  dpointtype  )

Parameters: dpointtype  the new value for the dp_type field of the datagram { // returns the dp_type field // it's used together with the constants byte[] tmp_dpointtype = this.getTransportControl(); tmp_dpointtype[2] = dpointtype; this.setTransportControl( tmp_dpointtype[0], tmp_dpointtype[1], tmp_dpointtype[2], tmp_dpointtype[3]); }

void de.stz.bt.fnd.FND_Datagram.setDateTime (  byte  year, byte  month, byte  day, byte  hour, byte  minute, byte  second )  throws IndexOutOfBoundsException

Date and time the datagram was created. Parameters: year  Allowed values: 0-99. month  Allowed values: 1-12. day  Allowed values: 1-31. hour  Allowed values: 0-23. minute  Allowed values: 0-59. second  Allowed values: 0-59. Exceptions: IndexOutOfBoundsException  In case any of the parameters exceeds its maximum value. { if (year > 99) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter year, above maximum, value=" + year + "maximum value=99")); } if (month == 0) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter month, below minimum, value=" + month + "minumum value=1")); } else if (month > 12) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter month, above maximum, value=" + month + "maximum value=12")); } if (day == 0) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter day, below minimum, value=" + day + "minimum value=1")); } else if (day > 31) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter day, above maximum, value=" + day + "maximum value=31")); } if (hour > 23) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter hour, above maximum, value=" + hour + "maximum value=23")); } if (minute > 59) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter minute, above maximum, value=" + minute + "maximum value=59")); } if (second > 59) { throw ( new IndexOutOfBoundsException( "FND_Datagram.SetDateTime() parameter second, above maximum, value=" + second + "maximum value=59")); } this.data[32] = year; this.data[33] = month; this.data[34] = day; this.data[35] = hour; this.data[36] = minute; this.data[37] = second; }

void de.stz.bt.fnd.FND_Datagram.setInfoCode (  byte  exc_1, byte  exc_2 )

If the parameter "tag" from the transport control byte is 1, the datagram has been rejected. The info-code is used to specify the reason for the reject. If the parameter "tag" from the transport control byte is 2, the datagram contains a syntactical error. The info-code parameter exc_1 points to the byte inside the data-part where the error occured. exc_2 contains additional information about the error. When creating message or command datagrams both values have to be 0. Possible values for the two parameters exc_1 and exc_2: exc_1 exc_2 Explanation 1 0 Recieved an unexpected datagram segment. 2 0 Recieved an unexpected datagram start segment, or an unsegmented datagram while trying to reassemble a fragmented datagram. 3 seg_exp Recieved a datagram segment with an unexpected segment number. "seg_exp" is the expected segment number. 4 0 "invoke_id" busy. Some other taks is still beeing processed. 5 0 DataPoint not accessable. 5 1 DataPoint served locally. 5 2 DataPoint locked. 6 0 DataPoint busy. Some other task is still beeing processed. 7 0 Central control not acessable. 8 0 Island control not accessable 9 apr No suficcent access rights. (prd < apr) 10 0 Authentification mechanism currently running. Parameters: exc_1  See above. exc_2  See above. { this.data[30] = exc_1; this.data[31] = exc_2; }

void de.stz.bt.fnd.FND_Datagram.setInfoEvent (  byte  info, byte  event )  throws IndexOutOfBoundsException

These Settings are used to specify additional information about the data-point and wich events occured. The possible parameter values depend on the type of the data point. Parameters: info  Specifies additional information about the data-point. No cheking is done wether the supplied values are valid for the very datagram, as it depends on the datapoint-type. event  Specifies wich events have occured. The possible values depend on the datapoint-type. Exceptions: IndexOutOfBoundsException  In case a parameter exceeds it's maximum value this exception is thrown. { if (info > 15) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setInfoEvent() parameter info, above maximum, value=" + info + "maximum value=15")); } if (event > 15) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setInfoEvent() parameter event, above maximum, value=" + event + "maximum value=15")); } this.data[29] = info; this.data[29] <<= 4; this.data[29] |= event; }

void de.stz.bt.fnd.FND_Datagram.setInvokeID (  byte  invokeID  )

The invode ID is used as an internal flow control and securing mechanism. It limits the number of currently pending request or processings by issueing a ticket (the invokeID) out of a limited pool. After completion of the request or process, the ticket is returned to the pool and can be issued again. If all avaialable tickets are in use no more request are accepted. Parameters: invokeID  { this.data[4] = invokeID; }

void de.stz.bt.fnd.FND_Datagram.setIslandControl (  byte  islandControlID, byte  islandControlSubID )

This information is used to indentify the island control associated with the datagram Parameters: islandControlID  Used to indetify the island control. islandControlSubID  Optional ID (default 0), connects the datagram with a corresponding Process. { this.data[7] = islandControlID; this.data[8] = islandControlSubID; }

void de.stz.bt.fnd.FND_Datagram.setLen (  byte  len  )

Set Length of Datagram. Has to be the complete length of FND_Datagram (in bytes) minus 2. Parameters: len  Length of FND_Datagram. { this.data[1] = len; }

void de.stz.bt.fnd.FND_Datagram.setMask (  byte  val, byte  apr, byte  mis, byte  msk )  throws IndexOutOfBoundsException

These settings are used to specify permissions and the message surpression of a datapoint. mis and msk: Island specific message surpression affects central-control message surpression. If messages are surpressed island-specific, they are surpressed central-control-specific, too. val and apr: Permissions are needed to make sure that information altering datagrams don't conflict with each other. Command datagrams and datagrams for transferpoints have both val and apr set to 0. Parameters: val  val Meaning 0 0 Central control exclusive: Unrestricted modification by central control. Island control isn't allowed to modify anything at all. 0 1 Central control preference: Highest priority (3) can only be set and changed by central control. 1 0 Island control preference: Highest priority (3) can only be set and changed by island control. 0 0 Island control exclusive: Unrestricted modification by Island control. Central control is allowed to change DP_#0 only. apr  Access priority. It's value represents the current access priority held by the datapoint at the moment. It can be used to decide wether sending a datagram to change options of the datapoint makes sense or would be blocked anyway. mis  Specifies the type of messages to be surpressed (island-specific). 0 = Nothing is surpressed. 1 = Operational Messages are surpressed. 2 = Operational and BTA-Error messages are surpressed. 3 = All Messages are surpressed. msk  Specifies the type of messages to be surpressed (central-control-specific). 0 = Nothing is surpressed. 1 = Operational Messages are surpressed. 2 = Operational and BTA-Error messages are surpressed. 3 = All Messages are surpressed. Exceptions: IndexOutOfBoundsException  In Case any of the supplied parameters exceeds its maximum value, this exception is thrown. { if (val > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setMask() parameter val, above maximum, value=" + val + "maximum value=3")); } if (apr > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setMask() parameter apr, above maximum, value=" + apr + "maximum value=3")); } if (mis > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setMask() parameter mis, above maximum, value=" + mis + "maximum value=3")); } if (msk > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setMask() parameter msk, above maximum, value=" + msk + "maximum value=3")); } this.data[28] = val; this.data[28] <<= 2; this.data[28] |= apr; this.data[28] <<= 2; this.data[28] |= mis; this.data[28] <<= 2; this.data[28] |= msk; }

void de.stz.bt.fnd.FND_Datagram.setOperationsCode (  byte  fct_id, byte  tab_id, byte  dp_type, byte  dp_subtype )  throws IndexOutOfBoundsException

Sets all parameters of the operations code. It is used to determine wich operation is requested and wich DataPoint tables is to be modified. Parameters: fct_id  One of three elementary funcions: 0 = Implizit (only valid for transferpoints, meaning has to specified) 1 = Read (Reading of DataPoint tables) 2 = Modify (Modifying of DataPoint tables) tab_id  One of four values, that determine the DataPoint table to be affected. 0 = DataPoint table 0 1 = DataPoint table 1 2 = DataPoint table 2 3 = DataPoint table 1 and 2 dp_type  The datapoint type. 0 = Transferpoint 1 = Messagepoint 2 = Switchpoint 3 = Measurepoint 4 = Settingpoint 5 = Countingpoint 6 = Collectionpoint dp_subtype  The datapoint subtype. Transferpoints are the only Datapoints using this parameter. The possible values, depending on the DataPoint ID are specified as followed: DataPoint type Datpoint subtype Comment 0 0 Adresspoint for transparent data transfer 1 Adresspoint for error messages 2 Authentification point Exceptions: IndexOutOfBoundsException  In Case any of the supplied parameters exceeds its maximum value, this exception is thrown. { if (fct_id > 2) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setOperationsCode: Parameter fct_id, above maximum, value=" + fct_id + "maximum value=2")); } if (tab_id > 3) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setOperationsCode: Parameter tab_id, above maximum, value=" + tab_id + "maximum value=3")); } if (dp_type > 6) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setOperationsCode: Parameter dp_type, above maximum, value=" + dp_type + "maximum value=6")); } if (dp_subtype > 6) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setOperationsCode: Parameter dp_subtype, above maximum, value=" + dp_subtype + "maximum value=6")); } // Adding and shifting this.data[25] = fct_id; this.data[25] <<= 4; this.data[25] |= tab_id; this.data[26] = dp_type; this.data[26] <<= 4; this.data[26] |= dp_subtype; }

void de.stz.bt.fnd.FND_Datagram.setSegmentNr (  byte  segNr  )

Used to set the segment number. If there is no segmentation, the value is zero. In case there is a segmentation this number needs to be a 0-based, continously increasing value, used in all fragments of the FND datagram. Parameters: segNr  Segment number. { this.data[3] = segNr; }

void de.stz.bt.fnd.FND_Datagram.setSender (  InetAddress  address  )

Parameters: address  sets the InetAdress object { sender = address; }

void de.stz.bt.fnd.FND_Datagram.setTransportControl (  byte  d_r, byte  tag, byte  mpr, byte  seg )  throws IndexOutOfBoundsException

Creates the transport control byte by combining all the function parameters. The maximum value for every parameter is 3. Parameters: d_r  Direction and response bits. tag  Type of Telegram. 0 = NORMAL-Datagram 1 = REJECT-Datagram 2 = ERROR-Datagram 3 = reserved mpr  Datagram priority. The higher the value the higher the priority. seg  Segmentation status. 0 = no segementation 3 = segmentation: first element 2 = segmentation: following element 1 = segemantation: last element Exceptions: IndexOutOfBoundsException  In case any parameter exceeds its maximum value this exception is thrown { // Check wether any parameter has exceeded it's maximum allowed value. if (d_r >= 4) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setTransportControl: d_r parameter, above maximum, value=" + d_r + " maximum value=3")); } if (tag >= 4) { throw ( new IndexOutOfBoundsException( "FND_Datagram.setTransportControl: tag parameter, above maximum, value=" + tag + " maximum value=3")); } if (mpr >= 4) { throw ( new IndexOutOfBoundsException( "FND_Datagram-setTransportControl: mpr parameter, above maximum, value=" + mpr + " maximum value=3")); } if (seg >= 4) { throw ( new IndexOutOfBoundsException( "FND_Datagram-setTransportControl: seg parameter, above maximum, value=" + seg + " maximum value=3")); } this.data[2] = d_r; this.data[2] <<= 2; this.data[2] |= tag; this.data[2] <<= 2; this.data[2] |= mpr; this.data[2] <<= 2; this.data[2] |= seg; }

---

The documentation for this class was generated from the following file:

• FND_Datagram.java

---