AddScheduledSleepReq (UnetStack 3.2.0 API)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.arl.unet.scheduler.AddScheduledSleepReq

Request to add a scheduled sleep.

Field Summary

Fields
Modifiers	Name	Description
`protected SleepCycle`	`sleepCycle`

Constructor Summary

Constructors
Constructor and description
`AddScheduledSleepReq ()` Request immediate sleep forever.
`AddScheduledSleepReq (Date wakeupTime)` Request immediate sleep until a specified time.
`AddScheduledSleepReq (long wakeupTime)` Request immediate sleep until a specified time.
`AddScheduledSleepReq (Date sleepTime, Date wakeupTime)` Request sleep from a given time until a wakeup time.
`AddScheduledSleepReq (long sleepTime, long wakeupTime)` Request sleep from a given time until a wakeup time.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`SleepCycle`	`getSleepCycle()` Gets the sleep/wakeup times.
	`Date`	`getSleepTime()` Gets the sleep time.
	`Date`	`getWakeupTime()` Gets the wakeup time.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`toString, setRecipient, setPerformative, getPerformative, getRecipient, setSender, getSender, setMessageID, getMessageID, setInReplyTo, getInReplyTo, setSentAt, getSentAt, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected SleepCycle sleepCycle
- Constructor Detail
  - public AddScheduledSleepReq()
    
    Request immediate sleep forever.
  - public AddScheduledSleepReq(Date wakeupTime)
    
    Request immediate sleep until a specified time.
    Parameters:
    wakeupTime - time to wake up
  - public AddScheduledSleepReq(long wakeupTime)
    
    Request immediate sleep until a specified time.
    Parameters:
    wakeupTime - time to wake up (Unix epoch time)
  - public AddScheduledSleepReq(Date sleepTime, Date wakeupTime)
    
    Request sleep from a given time until a wakeup time.
    Parameters:
    sleepTime - time to go to sleep
    wakeupTime - time to wake up
  - public AddScheduledSleepReq(long sleepTime, long wakeupTime)
    
    Request sleep from a given time until a wakeup time.
    Parameters:
    sleepTime - time to go to sleep (Unix epoch time)
    wakeupTime - time to wake up (Unix epoch time)
- Method Detail
  - public SleepCycle getSleepCycle()
    
    Gets the sleep/wakeup times.
    Returns:
    sleep and wakeup time
  - public Date getSleepTime()
    
    Gets the sleep time.
    Returns:
    sleep time
  - public Date getWakeupTime()
    
    Gets the wakeup time.
    Returns:
    wakeup time
  - @Override public String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Copyright 2013-19, Acoustic Research Laboratory, National University of Singapore, and Subnero Pte Ltd