TxFrameNtf (UnetStack 3.0.2 API)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.arl.unet.phy.TxFrameNtf

Notification of a successfully transmitted frame with tx timestamp. It is sent when TxFrameReq message is processed and frame is transmitted by physical agent.
See Also:
TxFrameReq

Field Summary

Fields
Modifiers	Name	Description
`protected double[]`	`location`
`protected Long`	`txTime`
`protected int`	`type`

Constructor Summary

Constructors
Constructor and description
`TxFrameNtf ()`
`TxFrameNtf (AgentID recipient)`
`TxFrameNtf (Message inReplyTo)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`double[]`	`getLocation()` Gets the location where this frame was received.
	`Long`	`getTxTime()` Returns transmission timestamp.
	`int`	`getType()` Gets the frame type.
	`void`	`setLocation(double[] location)` Sets the location where this frame was received.
	`void`	`setTxTime(Long time)` Sets the transmission timestamp in us.
	`void`	`setTxTime(long time)` Sets the transmission timestamp in us.
	`void`	`setType(int type)` Sets the frame type.
	`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, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected double[] location
  - protected Long txTime
  - protected int type
- Constructor Detail
  - public TxFrameNtf()
  - public TxFrameNtf(AgentID recipient)
  - public TxFrameNtf(Message inReplyTo)
- Method Detail
  - public double[] getLocation()
    
    Gets the location where this frame was received.
    Returns:
    location (x, y) or (x, y, z), or null if unavailable
  - public Long getTxTime()
    
    Returns transmission timestamp. Time stamp indicates the start of frame transmission.
    Returns:
    Tx timestamp in us
  - public int getType()
    
    Gets the frame type.
    Returns:
    type (frame type control or data).
  - public void setLocation(double[] location)
    
    Sets the location where this frame was received.
    Parameters:
    location - coordinates (x, y) or (x, y, z), or null if unavailable
  - public void setTxTime(Long time)
    
    Sets the transmission timestamp in us.
    Parameters:
    time - framework timestamp in us.
  - public void setTxTime(long time)
    
    Sets the transmission timestamp in us.
    Parameters:
    time - framework timestamp in us.
  - public void setType(int type)
    
    Sets the frame type.
    Parameters:
    type - frame type
  - @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