Click or drag to resize

ChangeSleepStateResponse Class

** NOTE: ADDED in CFX 1.3 **

Response to an external source to modify a generic configuration parameter of a process endpoint.
Copy
{
  "Result": {
    "Result": "Success",
    "ResultCode": 0,
    "Message": "OK"
  },
  "OldSleepState": "Hibernate",
  "NewSleepState": "Awake",
  "Stage": {
    "StageSequence": 2,
    "StageName": "Stage 1",
    "StageType": "Work"
  },
  "Lane": null,
  "TransitionTimeRemaining": "00:00:45"
}
Inheritance Hierarchy
SystemObject
  CFXCFXMessage
    CFX.ResourcePerformanceChangeSleepStateResponse

Namespace: CFX.ResourcePerformance
Assembly: CFX (in CFX.dll) Version: 2.0.0+5bb1f71a933ed371a0f5f2d5e7db34c89b75f3ea
Syntax
Copy
public class ChangeSleepStateResponse : CFXMessage

The ChangeSleepStateResponse type exposes the following members.

Constructors
 NameDescription
Public methodChangeSleepStateResponse Initializes a new instance of the ChangeSleepStateResponse class.
Top
Properties
 NameDescription
Public propertyLane The relevant production lane (if applicable)
Public propertyNewSleepState The new sleep state
Public propertyOldSleepState An enumeration indicating the previous sleep state prior to this state change
Public propertyResult The result of the request
Public propertyStage The stage that has changed sleep state. If omitted then the sleep state for the whole station has been changed.
Public propertyTransitionTimeRemaining If the new sleep state requires less wake up time than the old, this indicates that the state is in the process of being changed. Time interval can be nullable (for example if there is no time remaining).
Top
See Also