FunctionCode (dnp3 0.9.0 API)

java.lang.Object
- java.lang.Enum<FunctionCode>
- - io.stepfunc.dnp3.FunctionCode

All Implemented Interfaces:

Serializable, Comparable<FunctionCode>
```
public enum FunctionCode
extends Enum<FunctionCode>
```
Application layer function code

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORT_FILE` Outstation shall abort a file transfer operation (value == 30)
`ASSIGN_CLASS` Outstation shall assign the events generated by the points specified by the objects in the request to one of the classes (value == 22)
`AUTHENTICATE_FILE` Outstation shall return a file authentication key (value == 29)
`CLOSE_FILE` Outstation shall close a file (value == 26)
`COLD_RESTART` Outstation shall perform a complete reset of all hardware and software in the device (value == 13)
`CONFIRM` Master sends this to an outstation to confirm the receipt of an Application Layer fragment (value == 0)
`DELAY_MEASURE` Outstation shall report the time it takes to process and initiate the transmission of its response (value == 23)
`DELETE_FILE` Outstation shall delete a file (value == 27)
`DIRECT_OPERATE` Outstation shall immediately actuate the output points specified by the objects in the request (value == 5)
`DIRECT_OPERATE_NO_RESPONSE` Same as DirectOperate but outstation shall not send a response (value == 6)
`DISABLE_UNSOLICITED` Prevents outstation from initiating unsolicited responses from points specified by the objects in the request (value == 21)
`ENABLE_UNSOLICITED` Enables outstation to initiate unsolicited responses from points specified by the objects in the request (value == 20)
`FREEZE_AT_TIME` Outstation shall copy the point data values specified by the objects in the request to a separate freeze buffer at the time and/or time intervals specified in a special time data information object (value == 11)
`FREEZE_AT_TIME_NO_RESPONSE` Same as FreezeAtTime but outstation shall not send a response (value == 12)
`FREEZE_CLEAR` Outstation shall copy the point data values specified by the objects in the request into a separate freeze buffer and then clear the values (value == 9)
`FREEZE_CLEAR_NO_RESPONSE` Same as FreezeClear but outstation shall not send a response (value == 10)
`GET_FILE_INFO` Outstation shall retrieve information about a file (value == 28)
`IMMEDIATE_FREEZE` Outstation shall copy the point data values specified by the objects in the request to a separate freeze buffer (value == 7)
`IMMEDIATE_FREEZE_NO_RESPONSE` Same as ImmediateFreeze but outstation shall not send a response (value == 8)
`INITIALIZE_APPLICATION` Outstation shall place the applications specified by the objects in the request into the ready to run state (value == 16)
`INITIALIZE_DATA` Obsolete-Do not use for new designs (value == 15)
`OPEN_FILE` Outstation shall open a file (value == 25)
`OPERATE` Outstation shall activate the output points selected (or armed) by a previous select function code command (value == 4)
`READ` Outstation shall return the data specified by the objects in the request (value == 1)
`RECORD_CURRENT_TIME` Outstation shall save the time when the last octet of this message is received (value == 24)
`RESPONSE` Master shall interpret this fragment as an Application Layer response to an ApplicationLayer request (value == 129)
`SAVE_CONFIGURATION` This code is deprecated-Do not use for new designs (value == 19)
`SELECT` Outstation shall select (or arm) the output points specified by the objects in the request in preparation for a subsequent operate command (value == 3)
`START_APPLICATION` Outstation shall start running the applications specified by the objects in the request (value == 17)
`STOP_APPLICATION` Outstation shall stop running the applications specified by the objects in the request (value == 18)
`UNSOLICITED_RESPONSE` Master shall interpret this fragment as an unsolicited response that was not prompted by an explicit request (value == 130)
`WARM_RESTART` Outstation shall reset only portions of the device (value == 14)
`WRITE` Outstation shall store the data specified by the objects in the request (value == 2)

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FunctionCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FunctionCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CONFIRM
```
public static final FunctionCode CONFIRM
```
    Master sends this to an outstation to confirm the receipt of an Application Layer fragment (value == 0)
  - READ
```
public static final FunctionCode READ
```
    Outstation shall return the data specified by the objects in the request (value == 1)
  - WRITE
```
public static final FunctionCode WRITE
```
    Outstation shall store the data specified by the objects in the request (value == 2)
  - SELECT
```
public static final FunctionCode SELECT
```
    Outstation shall select (or arm) the output points specified by the objects in the request in preparation for a subsequent operate command (value == 3)
  - OPERATE
```
public static final FunctionCode OPERATE
```
    Outstation shall activate the output points selected (or armed) by a previous select function code command (value == 4)
  - DIRECT_OPERATE
```
public static final FunctionCode DIRECT_OPERATE
```
    Outstation shall immediately actuate the output points specified by the objects in the request (value == 5)
  - DIRECT_OPERATE_NO_RESPONSE
```
public static final FunctionCode DIRECT_OPERATE_NO_RESPONSE
```
    Same as DirectOperate but outstation shall not send a response (value == 6)
  - IMMEDIATE_FREEZE
```
public static final FunctionCode IMMEDIATE_FREEZE
```
    Outstation shall copy the point data values specified by the objects in the request to a separate freeze buffer (value == 7)
  - IMMEDIATE_FREEZE_NO_RESPONSE
```
public static final FunctionCode IMMEDIATE_FREEZE_NO_RESPONSE
```
    Same as ImmediateFreeze but outstation shall not send a response (value == 8)
  - FREEZE_CLEAR
```
public static final FunctionCode FREEZE_CLEAR
```
    Outstation shall copy the point data values specified by the objects in the request into a separate freeze buffer and then clear the values (value == 9)
  - FREEZE_CLEAR_NO_RESPONSE
```
public static final FunctionCode FREEZE_CLEAR_NO_RESPONSE
```
    Same as FreezeClear but outstation shall not send a response (value == 10)
  - FREEZE_AT_TIME
```
public static final FunctionCode FREEZE_AT_TIME
```
    Outstation shall copy the point data values specified by the objects in the request to a separate freeze buffer at the time and/or time intervals specified in a special time data information object (value == 11)
  - FREEZE_AT_TIME_NO_RESPONSE
```
public static final FunctionCode FREEZE_AT_TIME_NO_RESPONSE
```
    Same as FreezeAtTime but outstation shall not send a response (value == 12)
  - COLD_RESTART
```
public static final FunctionCode COLD_RESTART
```
    Outstation shall perform a complete reset of all hardware and software in the device (value == 13)
  - WARM_RESTART
```
public static final FunctionCode WARM_RESTART
```
    Outstation shall reset only portions of the device (value == 14)
  - INITIALIZE_DATA
```
public static final FunctionCode INITIALIZE_DATA
```
    Obsolete-Do not use for new designs (value == 15)
  - INITIALIZE_APPLICATION
```
public static final FunctionCode INITIALIZE_APPLICATION
```
    Outstation shall place the applications specified by the objects in the request into the ready to run state (value == 16)
  - START_APPLICATION
```
public static final FunctionCode START_APPLICATION
```
    Outstation shall start running the applications specified by the objects in the request (value == 17)
  - STOP_APPLICATION
```
public static final FunctionCode STOP_APPLICATION
```
    Outstation shall stop running the applications specified by the objects in the request (value == 18)
  - SAVE_CONFIGURATION
```
public static final FunctionCode SAVE_CONFIGURATION
```
    This code is deprecated-Do not use for new designs (value == 19)
  - ENABLE_UNSOLICITED
```
public static final FunctionCode ENABLE_UNSOLICITED
```
    Enables outstation to initiate unsolicited responses from points specified by the objects in the request (value == 20)
  - DISABLE_UNSOLICITED
```
public static final FunctionCode DISABLE_UNSOLICITED
```
    Prevents outstation from initiating unsolicited responses from points specified by the objects in the request (value == 21)
  - ASSIGN_CLASS
```
public static final FunctionCode ASSIGN_CLASS
```
    Outstation shall assign the events generated by the points specified by the objects in the request to one of the classes (value == 22)
  - DELAY_MEASURE
```
public static final FunctionCode DELAY_MEASURE
```
    Outstation shall report the time it takes to process and initiate the transmission of its response (value == 23)
  - RECORD_CURRENT_TIME
```
public static final FunctionCode RECORD_CURRENT_TIME
```
    Outstation shall save the time when the last octet of this message is received (value == 24)
  - OPEN_FILE
```
public static final FunctionCode OPEN_FILE
```
    Outstation shall open a file (value == 25)
  - CLOSE_FILE
```
public static final FunctionCode CLOSE_FILE
```
    Outstation shall close a file (value == 26)
  - DELETE_FILE
```
public static final FunctionCode DELETE_FILE
```
    Outstation shall delete a file (value == 27)
  - GET_FILE_INFO
```
public static final FunctionCode GET_FILE_INFO
```
    Outstation shall retrieve information about a file (value == 28)
  - AUTHENTICATE_FILE
```
public static final FunctionCode AUTHENTICATE_FILE
```
    Outstation shall return a file authentication key (value == 29)
  - ABORT_FILE
```
public static final FunctionCode ABORT_FILE
```
    Outstation shall abort a file transfer operation (value == 30)
  - RESPONSE
```
public static final FunctionCode RESPONSE
```
    Master shall interpret this fragment as an Application Layer response to an ApplicationLayer request (value == 129)
  - UNSOLICITED_RESPONSE
```
public static final FunctionCode UNSOLICITED_RESPONSE
```
    Master shall interpret this fragment as an unsolicited response that was not prompted by an explicit request (value == 130)
- Method Detail
  - values
```
public static FunctionCode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FunctionCode c : FunctionCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FunctionCode valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum FunctionCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CONFIRM

READ

WRITE

SELECT

OPERATE

DIRECT_OPERATE

DIRECT_OPERATE_NO_RESPONSE

IMMEDIATE_FREEZE

IMMEDIATE_FREEZE_NO_RESPONSE

FREEZE_CLEAR

FREEZE_CLEAR_NO_RESPONSE

FREEZE_AT_TIME

FREEZE_AT_TIME_NO_RESPONSE

COLD_RESTART

WARM_RESTART

INITIALIZE_DATA

INITIALIZE_APPLICATION

START_APPLICATION

STOP_APPLICATION

SAVE_CONFIGURATION

ENABLE_UNSOLICITED

DISABLE_UNSOLICITED

ASSIGN_CLASS

DELAY_MEASURE

RECORD_CURRENT_TIME

OPEN_FILE

CLOSE_FILE

DELETE_FILE

GET_FILE_INFO

AUTHENTICATE_FILE

ABORT_FILE

RESPONSE

UNSOLICITED_RESPONSE

Method Detail

values

valueOf