iotjava/iotruntime/messages/MessageGetDeviceObject.java

   1 package iotruntime.messages;
   2
   3 import java.io.Serializable;
   4
   5 /** Class MessageGetDeviceObject is a sub class of Message
   6  *  This class wraps-up a message to get device object, i.e.
   7  *  IoTSet that contains are IoTDeviceAddress objects
   8  *
   9  * @author      Rahmadi Trimananda <rahmadi.trimananda @ uci.edu>
  10  * @version     1.0
  11  * @since       2016-02-24
  12  */
  13 public class MessageGetDeviceObject extends Message {
  14
  15         /**
  16          * MessageGetDeviceObject class property
  17          */
  18         private String sHostAddress;
  19         private int iSrcDevDrvPort;
  20         private int iDstDevDrvPort;
  21         private boolean bSrcPortWildCard;
  22         private boolean bDstPortWildCard;
  23
  24         /**
  25          * Class constructor (to tell IoTSlave to get objects for IoTSet that contains IoTDeviceAddress objects)
  26          */
  27         public MessageGetDeviceObject(IoTCommCode sMsg, String sHAddress, int iSDDPort, int iDDDPort,
  28                 boolean bSPWildCard, boolean bDPWildCard) {
  29
  30                 super(sMsg);
  31                 sHostAddress = sHAddress;
  32                 iSrcDevDrvPort = iSDDPort;
  33                 iDstDevDrvPort = iDDDPort;
  34                 bSrcPortWildCard = bSPWildCard;
  35                 bDstPortWildCard = bDPWildCard;
  36         }
  37
  38         /**
  39          * getHostAddress() method
  40          *
  41          * @return  String
  42          */
  43         public String getHostAddress() {
  44                 return sHostAddress;
  45         }
  46
  47         /**
  48
  49          * getSourceDeviceDriverPort() method
  50          *
  51          * @return  int
  52          */
  53         public int getSourceDeviceDriverPort() {
  54                 return iSrcDevDrvPort;
  55         }
  56
  57         /**
  58
  59          * getDestinationDeviceDriverPort() method
  60          *
  61          * @return  int
  62          */
  63         public int getDestinationDeviceDriverPort() {
  64                 return iDstDevDrvPort;
  65         }
  66
  67         /* isSourcePortWildCard() method
  68          *
  69          * @return  boolean  Source port wild card option (true/false)
  70          */
  71         public boolean isSourcePortWildCard() {
  72                 return bSrcPortWildCard;
  73         }
  74
  75         /* isDestinationPortWildCard() method
  76          *
  77          * @return  boolean  Destination port wild card option (true/false)
  78          */
  79         public boolean isDestinationPortWildCard() {
  80                 return bDstPortWildCard;
  81         }
  82
  83         /**
  84          * setHostAddress() method
  85          *
  86          * @param   sHAddress  String host address
  87          * @return  void
  88          */
  89         public void setHostAddress(String sHAddress) {
  90                 sHostAddress = sHAddress;
  91         }
  92
  93         /* setSourceDeviceDriverPort() method
  94          *
  95          * @param   iSDDPort  Device driver port number
  96          * @return  void
  97          */
  98         public void setSourceDeviceDriverPort(int iSDDPort) {
  99                 iSrcDevDrvPort = iSDDPort;
 100         }
 101
 102         /* setDestinationDeviceDriverPort() method
 103          *
 104          * @param   iDDDPort  Device driver port number
 105          * @return  void
 106          */
 107         public void setDestinationDeviceDriverPort(int iDDDPort) {
 108                 iDstDevDrvPort = iDDDPort;
 109         }
 110
 111         /* setSourcePortWildCard() method
 112          *
 113          * @param   bSPWildCard  Port wild card option (true/false)
 114          * @return  void
 115          */
 116         public void setSourcePortWildCard(boolean bSPWildCard) {
 117                 bSrcPortWildCard = bSPWildCard;
 118         }
 119
 120         /* setDestionationPortWildCard() method
 121          *
 122          * @param   bDPWildCard  Port wild card option (true/false)
 123          * @return  void
 124          */
 125         public void setDestionationPortWildCard(boolean bDPWildCard) {
 126                 bDstPortWildCard = bDPWildCard;
 127         }
 128 }