CommandStatusType (crcl4java-base 1.3 API)

java.lang.Object
- crcl.base.DataThingType
- - crcl.base.CommandStatusType

```
public class CommandStatusType
extends DataThingType
```
CommandStatusType is derived from DataThingType. An instance of CommandStatusType has the following elements: Name (inherited, optional) CommandID StatusID CommandState StateDescription (optional) ProgramFile (optional) ProgramIndex (optional) ProgramLength (optional). The CommandStatusType relates the execution status of the currently executing command (or the most recently executed command, if there is no current command). CommandID echoes the command id from the received command to which the status message applies StatusID is an ID associated with this particular status message. StateDescription is an optional brief description of the state such as "Joint 3 at -171.0 less than limit -170.0" or "Waiting for Operator". ProgramFile provides an optional reference if the currently executing command is known to have come from a particular file. ProgramIndex provoides an optional reference to the element within a program. If the currently executing command is known to have come from a particular file. The InitCanon command will have index 0, and first MiddleCommand will have index 1. ProgramLength is the number of commands in the current program if known. The combination of StatusID and CommandID must be unique within a session.
Java class for CommandStatusType complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="CommandStatusType">
   <complexContent>
     <extension base="{}DataThingType">
       <sequence>
         <element name="CommandID" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger"/>
         <element name="StatusID" type="{http://www.w3.org/2001/XMLSchema}positiveInteger"/>
         <element name="CommandState" type="{}CommandStateEnumType"/>
         <element name="StateDescription" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ProgramFile" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ProgramIndex" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" minOccurs="0"/>
         <element name="ProgramLength" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigInteger`	`commandID`
`protected CommandStateEnumType`	`commandState`
`protected String`	`programFile`
`protected BigInteger`	`programIndex`
`protected BigInteger`	`programLength`
`protected String`	`stateDescription`
`protected BigInteger`	`statusID`

Fields inherited from class crcl.base.DataThingType
name

Constructor Summary

Constructors
Constructor and Description

CommandStatusType()

Constructors
Constructor and Description
`CommandStatusType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigInteger`	`getCommandID()` Gets the value of the commandID property.
`CommandStateEnumType`	`getCommandState()` Gets the value of the commandState property.
`String`	`getProgramFile()` Gets the value of the programFile property.
`BigInteger`	`getProgramIndex()` Gets the value of the programIndex property.
`BigInteger`	`getProgramLength()` Gets the value of the programLength property.
`String`	`getStateDescription()` Gets the value of the stateDescription property.
`BigInteger`	`getStatusID()` Gets the value of the statusID property.
`void`	`setCommandID(BigInteger value)` Sets the value of the commandID property.
`void`	`setCommandState(CommandStateEnumType value)` Sets the value of the commandState property.
`void`	`setProgramFile(String value)` Sets the value of the programFile property.
`void`	`setProgramIndex(BigInteger value)` Sets the value of the programIndex property.
`void`	`setProgramLength(BigInteger value)` Sets the value of the programLength property.
`void`	`setStateDescription(String value)` Sets the value of the stateDescription property.
`void`	`setStatusID(BigInteger value)` Sets the value of the statusID property.

Methods inherited from class crcl.base.DataThingType
getName, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - commandID
```
protected BigInteger commandID
```
  - statusID
```
protected BigInteger statusID
```
  - commandState
```
protected CommandStateEnumType commandState
```
  - stateDescription
```
protected String stateDescription
```
  - programFile
```
protected String programFile
```
  - programIndex
```
protected BigInteger programIndex
```
  - programLength
```
protected BigInteger programLength
```
- Constructor Detail
  - CommandStatusType
```
public CommandStatusType()
```
- Method Detail
  - getCommandID
```
public BigInteger getCommandID()
```
    Gets the value of the commandID property.
    
    Returns:
    
    possible object is BigInteger
  - setCommandID
```
public void setCommandID(BigInteger value)
```
    Sets the value of the commandID property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getStatusID
```
public BigInteger getStatusID()
```
    Gets the value of the statusID property.
    
    Returns:
    
    possible object is BigInteger
  - setStatusID
```
public void setStatusID(BigInteger value)
```
    Sets the value of the statusID property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getCommandState
```
public CommandStateEnumType getCommandState()
```
    Gets the value of the commandState property.
    
    Returns:
    
    possible object is CommandStateEnumType
  - setCommandState
```
public void setCommandState(CommandStateEnumType value)
```
    Sets the value of the commandState property.
    
    Parameters:
    
    value - allowed object is CommandStateEnumType
  - getStateDescription
```
public String getStateDescription()
```
    Gets the value of the stateDescription property.
    
    Returns:
    
    possible object is String
  - setStateDescription
```
public void setStateDescription(String value)
```
    Sets the value of the stateDescription property.
    
    Parameters:
    
    value - allowed object is String
  - getProgramFile
```
public String getProgramFile()
```
    Gets the value of the programFile property.
    
    Returns:
    
    possible object is String
  - setProgramFile
```
public void setProgramFile(String value)
```
    Sets the value of the programFile property.
    
    Parameters:
    
    value - allowed object is String
  - getProgramIndex
```
public BigInteger getProgramIndex()
```
    Gets the value of the programIndex property.
    
    Returns:
    
    possible object is BigInteger
  - setProgramIndex
```
public void setProgramIndex(BigInteger value)
```
    Sets the value of the programIndex property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getProgramLength
```
public BigInteger getProgramLength()
```
    Gets the value of the programLength property.
    
    Returns:
    
    possible object is BigInteger
  - setProgramLength
```
public void setProgramLength(BigInteger value)
```
    Sets the value of the programLength property.
    
    Parameters:
    
    value - allowed object is BigInteger

Class CommandStatusType

Field Summary

Fields inherited from class crcl.base.DataThingType

Constructor Summary

Method Summary

Methods inherited from class crcl.base.DataThingType

Methods inherited from class java.lang.Object

Field Detail

commandID

statusID

commandState

stateDescription

programFile

programIndex

programLength

Constructor Detail

CommandStatusType

Method Detail

getCommandID

setCommandID

getStatusID

setStatusID

getCommandState

setCommandState

getStateDescription

setStateDescription

getProgramFile

setProgramFile

getProgramIndex

setProgramIndex

getProgramLength

setProgramLength