All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.arcsinc.hardwarehost.DataCmd 

java.lang.Object
   |
   +----com.arcsinc.hardwarehost.HdwCmd
           |
           +----com.arcsinc.hardwarehost.DataCmd
public class DataCmd
extends HdwCmd
The DataCmd class provides the mechanism to encapsulate data commands. The data command structure is flexible. It is used for any command which either sends, receives, or sends and receives data to the hardware application. Either int(s) or float(s) can be sent or received. Note, the data types cannot be fixed with an action (int and float cannot be sent to the hardware in the same command; however, int can be sent and float can be received t and float can be received in the same command). The size of data to be sent is dynamically determined; the size of the data to be received can be either dynamically determined or fixed per the designers wishes. If the hardware application cannot handle the command as sent, it will simply dispose of the command and take no action.

See Also:
HdwCmd

Variable Index

o FLOAT
Data is type float.
o INT
Data is type int.
o NONE
There is no data expected.

Constructor Index

o DataCmd()
Default constructor.
o DataCmd(char)
A constructor which only sets the command value.
o DataCmd(char, float[])
A constructor which instantiates a command for sending float data, no data will be received.
o DataCmd(char, int[])
A constructor which instantiates a command for sending int data, no data will be received.
o DataCmd(char, int[], float[], boolean, char, int)
The general purpose constructor which instantiates a command for sending and receiving data.

Method Index

o getDataIoFloat()
Get the value of dataIoFloat.
o getDataIoInt()
Get the value of dataIoInt.
o getDataRtnSize()
Get the value of dataRtnSize.
o getDynamicDataSizeRtn()
Get the value of dynamicDataSizeRtn.
o getRtnType()
Get the value of rtnType.
o setDataIoFloat(float[])
Set the value of dataIoFloat.
o setDataIoInt(int[])
Set the value of dataIoInt.
o setDataRtnSize(int)
Set the value of dataRtnSize.
o setDynamicDataSizeRtn(boolean)
Set the value of dynamicDataSizeRtn.
o setRtnType(char)
Set the value of rtnType.

Variables

o FLOAT 
 public static final char FLOAT
Data is type float.

o INT 
 public static final char INT
Data is type int.

o NONE 
 public static final char NONE
There is no data expected.

Constructors

o DataCmd 
 public DataCmd()
Default constructor.

o DataCmd 
 public DataCmd(char cmd)
A constructor which only sets the command value.

Parameters:
cmd - the command value.
o DataCmd 
 public DataCmd(char cmd,
                int dataIoInt[])
A constructor which instantiates a command for sending int data, no data will be received.

Parameters:
cmd - the command value.
dataIoInt - the int to be sent.
o DataCmd 
 public DataCmd(char cmd,
                float dataIoFloat[])
A constructor which instantiates a command for sending float data, no data will be received.

Parameters:
cmd - the command value.
dataIoFloat - the float to be sent.
- the float to be sent.
o DataCmd 
 public DataCmd(char cmd,
                int dataIoInt[],
                float dataIoFloat[],
                boolean dynamicDataSizeRtn,
 eRtn,
                char rtnType,
                int dataRtnSize)
The general purpose constructor which instantiates a command for sending and receiving data.

Parameters:
cmd - the command value.
dataIoInt - the float to be sent.
dataIoFloat - the float to be sent.
dynamicDataSizeRtn - true if the return size needs to be determined as the data is being received from the hardware.
rtnType - set to {INT | FLOAT | NONE}
dataRtnSize - number of int or float to return if dynamicDataSizeRtn is false.

Methods

o getDataRtnSize 
 public int getDataRtnSize()
Get the value of dataRtnSize.

Returns:
Value of dataRtnSize.
o setDataRtnSize 
 public void setDataRtnSize(int v)
Set the value of dataRtnSize.

et the value of dataRtnSize.

Parameters:
v - Value to assign to dataRtnSize.
o getDynamicDataSizeRtn 
 public boolean getDynamicDataSizeRtn()
Get the value of dynamicDataSizeRtn.

Returns:
Value of dynamicDataSizeRtn.
o setDynamicDataSizeRtn 
 public void setDynamicDataSizeRtn(boolean v)
Set the value of dynamicDataSizeRtn.

Parameters:
v - Value to assign to dynamicDataSizeRtn.
o getRtnType 
 public char getRtnType()
Get the value of rtnType.

Returns:
Value of rtnType.
o setRtnType 
 public void setRtnType(char v)
Set the value of rtnType.

Parameters:
v - Value to assign to rtnType.
o getDataIoInt 
 public int[] getDataIoInt()
Get the value of dataIoInt.

Returns:
Value of dataIoInt.
o setDataIoInt 
 public void setDataIoInt(int v[])
re> public void setDataIoInt(int v[])
Set the value of dataIoInt.

Parameters:
v - Value to assign to dataIoInt.
o getDataIoFloat 
 public float[] getDataIoFloat()
Get the value of dataIoFloat.

Returns:
Value of dataIoFloat.
o setDataIoFloat 
 public void setDataIoFloat(float v[])
Set the value of dataIoFloat.

Parameters:
v - Value to assign to dataIoFloat. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index
/body>