TxFrameStartNtf (UnetStack 3.0.2 API)

org.arl.unet.phy.TxFrameStartNtf

Notification message for start of transmission. To listen to these notifications subscribe to service Services#PHYSICAL#PHYSICAL.

Field Summary

Fields
Modifiers	Name	Description
`protected Integer`	`txDuration`
`protected Long`	`txTime`
`protected int`	`type`

Constructor Summary

Constructors
Constructor and description
`TxFrameStartNtf ()`
`TxFrameStartNtf (AgentID recipient)`
`TxFrameStartNtf (Message inReplyTo)`
`TxFrameStartNtf (AgentID recipient, Message inReplyTo)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Integer`	`getTxDuration()` Gets reception duration.
	`Long`	`getTxTime()` Gets transmission timestamp.
	`int`	`getType()` Gets the frame type.
	`void`	`setTxDuration(Integer duration)` Sets the reception duration in us.
	`void`	`setTxDuration(int duration)` Sets the reception duration in us.
	`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 Integer txDuration
  - protected Long txTime
  - protected int type
- Constructor Detail
  - public TxFrameStartNtf()
  - public TxFrameStartNtf(AgentID recipient)
  - public TxFrameStartNtf(Message inReplyTo)
  - public TxFrameStartNtf(AgentID recipient, Message inReplyTo)
- Method Detail
  - public Integer getTxDuration()
    
    Gets reception duration.
    Returns:
    estimated duration us, null if unavailable
  - public Long getTxTime()
    
    Gets transmission timestamp. Time stamp indicates the start of frame transmission. This timestamp may be less accurate than the corresponding TxFrameNtf timestamp, as the latter is sent after the transmission is made and has more certainty on the start time of the transmission.
    Returns:
    time timestamp in us, null if unavailable
  - public int getType()
    
    Gets the frame type.
    Returns:
    type (frame type control or data).
  - public void setTxDuration(Integer duration)
    
    Sets the reception duration in us.
    Parameters:
    duration - estimated duration in us.
  - public void setTxDuration(int duration)
    
    Sets the reception duration in us.
    Parameters:
    duration - estimated duration in us.
  - public void setTxTime(Long time)
    
    Sets the transmission timestamp in us.
    Parameters:
    time - timestamp in us.
  - public void setTxTime(long time)
    
    Sets the transmission timestamp in us.
    Parameters:
    time - 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

[Java] Class TxFrameStartNtf

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected Integer txDuration

protected Long txTime

protected int type

Constructor Detail

public TxFrameStartNtf()

public TxFrameStartNtf(AgentID recipient)

public TxFrameStartNtf(Message inReplyTo)

public TxFrameStartNtf(AgentID recipient, Message inReplyTo)

Method Detail

public Integer getTxDuration()

public Long getTxTime()

public int getType()

public void setTxDuration(Integer duration)

public void setTxDuration(int duration)

public void setTxTime(Long time)

public void setTxTime(long time)

public void setType(int type)

@Override public String toString()