TxFrameNtf (unet-framework 7.0.0 API)

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 java.lang.Long`	`txStartTime`
`protected int`	`type`

Inherited fields
Fields inherited from class	Fields
`class DatagramTransmissionNtf`	`to`

Properties Summary

Properties
Type	Name and description
`double[]`	`location`
`java.lang.Long`	`txStartTime`
`int`	`type`

Constructor Summary

Constructors
Constructor and description
`TxFrameNtf ()`
`TxFrameNtf (org.arl.fjage.AgentID recipient)`
`TxFrameNtf (org.arl.fjage.Message inReplyTo)`
`TxFrameNtf (DatagramReq inReplyTo)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`double[]`	`getLocation()` Gets the location where this frame was received.
	`java.lang.Long`	`getTxStartTime()` Returns transmission timestamp.
	`int`	`getType()` Gets the frame type.
	`void`	`setLocation(double[] location)` Sets the location where this frame was received.
	`void`	`setTxStartTime(java.lang.Long time)` Sets the transmission timestamp in us.
	`void`	`setTxStartTime(long time)` Sets the transmission timestamp in us.
	`void`	`setType(int type)` Sets the frame type.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DatagramTransmissionNtf`	`getTo, setTo, toString`

- Field Detail
  - protected double[] location
  - protected java.lang.Long txStartTime
  - protected int type
- Property Detail
  - double[] location
  - java.lang.Long txStartTime
  - int type
- Constructor Detail
  - public TxFrameNtf()
  - public TxFrameNtf(org.arl.fjage.AgentID recipient)
  - public TxFrameNtf(org.arl.fjage.Message inReplyTo)
  - public TxFrameNtf(DatagramReq 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 java.lang.Long getTxStartTime()
    
    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 setTxStartTime(java.lang.Long time)
    
    Sets the transmission timestamp in us. Time stamp indicates the start of frame transmission.
    Parameters:
    time - framework timestamp in us.
  - public void setTxStartTime(long time)
    
    Sets the transmission timestamp in us. Time stamp indicates the start of frame transmission.
    Parameters:
    time - framework timestamp in us.
  - public void setType(int type)
    
    Sets the frame type.
    Parameters:
    type - frame type
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class TxFrameNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected double[] location

protected java.lang.Long txStartTime

protected int type

Property Detail

double[] location

java.lang.Long txStartTime

int type

Constructor Detail

public TxFrameNtf()

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

public TxFrameNtf(org.arl.fjage.Message inReplyTo)

public TxFrameNtf(DatagramReq inReplyTo)

Method Detail

public double[] getLocation()

public java.lang.Long getTxStartTime()

public int getType()

public void setLocation(double[] location)

public void setTxStartTime(java.lang.Long time)

public void setTxStartTime(long time)

public void setType(int type)

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