ReservationNtf (unet-framework 7.0.0 API)

org.arl.unet.mac.ReservationNtf

Notification to be sent to the MAC agent by other agents who know about a channel reservation by other nodes, either by being a peer, or by snooping. If a reservation uses an ID that was previously used, the new reservation will replace the old one. Otherwise the new reservation will be added to the list of reservations.

Field Summary

Fields
Modifiers	Name	Description
`protected float`	`duration`
`protected java.lang.String`	`id`
`protected java.lang.Long`	`startTime`

Properties Summary

Properties
Type	Name and description
`float`	`duration`
`java.lang.String`	`id`
`java.lang.Long`	`startTime`

Constructor Summary

Constructors
Constructor and description
`ReservationNtf ()`
`ReservationNtf (org.arl.fjage.AgentID recipient)`
`ReservationNtf (org.arl.fjage.AgentID recipient, float duration)`
`ReservationNtf (org.arl.fjage.AgentID recipient, java.lang.String id, float duration)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`float`	`getDuration()` Gets the duration for which the channel will be reserved (in seconds).
	`java.lang.String`	`getId()` Gets the unique identifier for the reservation.
	`java.lang.Long`	`getStartTime()` Gets the starting time for the reservation.
	`void`	`setDuration(float duration)` Sets the duration for which the channel will be reserved (in seconds).
	`void`	`setId(java.lang.String id)` Sets the unique identifier for the reservation.
	`void`	`setStartTime(java.lang.Long time)` Sets the starting time for the reservation.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.arl.fjage.Message`	org.arl.fjage.Message#toString(), org.arl.fjage.Message#setPerformative(org.arl.fjage.Performative), org.arl.fjage.Message#getPerformative(), org.arl.fjage.Message#setRecipient(org.arl.fjage.AgentID), org.arl.fjage.Message#getRecipient(), org.arl.fjage.Message#setSender(org.arl.fjage.AgentID), org.arl.fjage.Message#getSender(), org.arl.fjage.Message#setMessageID(java.lang.String), org.arl.fjage.Message#getMessageID(), org.arl.fjage.Message#setInReplyTo(java.lang.String), org.arl.fjage.Message#getInReplyTo(), org.arl.fjage.Message#setSentAt(long), org.arl.fjage.Message#getSentAt(), org.arl.fjage.Message#getJsonCache(), org.arl.fjage.Message#setJsonCache(java.lang.String), org.arl.fjage.Message#wait(long, int), org.arl.fjage.Message#wait(long), org.arl.fjage.Message#wait(), org.arl.fjage.Message#equals(java.lang.Object), org.arl.fjage.Message#hashCode(), org.arl.fjage.Message#getClass(), org.arl.fjage.Message#notify(), org.arl.fjage.Message#notifyAll()

- Field Detail
  - protected float duration
  - protected java.lang.String id
  - protected java.lang.Long startTime
- Property Detail
  - float duration
  - java.lang.String id
  - java.lang.Long startTime
- Constructor Detail
  - public ReservationNtf()
  - public ReservationNtf(org.arl.fjage.AgentID recipient)
  - public ReservationNtf(org.arl.fjage.AgentID recipient, float duration)
  - public ReservationNtf(org.arl.fjage.AgentID recipient, java.lang.String id, float duration)
- Method Detail
  - public float getDuration()
    
    Gets the duration for which the channel will be reserved (in seconds).
    Returns:
    duration
  - public java.lang.String getId()
    
    Gets the unique identifier for the reservation.
    Returns:
    id
  - public java.lang.Long getStartTime()
    
    Gets the starting time for the reservation. The time is in microseconds according to the baseband clock. If the starting time is not specified, it is assumed that the reservation starts immediately.
    Returns:
    starting time in microseconds, or null if no specified starting time.
  - public void setDuration(float duration)
    
    Sets the duration for which the channel will be reserved (in seconds).
    Parameters:
    duration - in milliseconds
  - public void setId(java.lang.String id)
    
    Sets the unique identifier for the reservation.
    Parameters:
    id - unique identifier
  - public void setStartTime(java.lang.Long time)
    
    Sets the starting time for the reservation. The time is in microseconds according to the baseband clock. If the starting time is not specified, it is assumed that the reservation starts immediately.
    Parameters:
    time - starting time in microseconds, or null for unspecified.
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class ReservationNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected float duration

protected java.lang.String id

protected java.lang.Long startTime

Property Detail

float duration

java.lang.String id

java.lang.Long startTime

Constructor Detail

public ReservationNtf()

public ReservationNtf(org.arl.fjage.AgentID recipient)

public ReservationNtf(org.arl.fjage.AgentID recipient, float duration)

public ReservationNtf(org.arl.fjage.AgentID recipient, java.lang.String id, float duration)

Method Detail

public float getDuration()

public java.lang.String getId()

public java.lang.Long getStartTime()

public void setDuration(float duration)

public void setId(java.lang.String id)

public void setStartTime(java.lang.Long time)

@java.lang.Override public java.lang.String toString()