TxStartNtf (unet-framework 7.0.0 API)

org.arl.unet.bb.TxStartNtf

Notification message for start of transmission.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`preamble`
`protected java.lang.Integer`	`txDuration`
`protected java.lang.Long`	`txStartTime`

Properties Summary

Properties
Type	Name and description
`int`	`preamble`
`java.lang.Integer`	`txDuration`
`java.lang.Long`	`txStartTime`

Constructor Summary

Constructors
Constructor and description
`TxStartNtf ()`
`TxStartNtf (org.arl.fjage.AgentID recipient)`
`TxStartNtf (org.arl.fjage.Message inReplyTo)`
`TxStartNtf (org.arl.fjage.AgentID recipient, org.arl.fjage.Message inReplyTo)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getPreamble()` Gets the preamble ID.
	`java.lang.Integer`	`getTxDuration()` Gets reception duration.
	`java.lang.Long`	`getTxStartTime()` Gets transmission timestamp.
	`void`	`setPreamble(int preamble)` Sets the preamble ID.
	`void`	`setTxDuration(java.lang.Integer duration)` Sets the reception duration in us.
	`void`	`setTxDuration(int duration)` Sets the reception duration in us.
	`void`	`setTxStartTime(java.lang.Long time)` Sets the transmission timestamp in us.
	`void`	`setTxStartTime(long time)` Sets the transmission timestamp in us.
	`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 int preamble
  - protected java.lang.Integer txDuration
  - protected java.lang.Long txStartTime
- Property Detail
  - int preamble
  - java.lang.Integer txDuration
  - java.lang.Long txStartTime
- Constructor Detail
  - public TxStartNtf()
  - public TxStartNtf(org.arl.fjage.AgentID recipient)
  - public TxStartNtf(org.arl.fjage.Message inReplyTo)
  - public TxStartNtf(org.arl.fjage.AgentID recipient, org.arl.fjage.Message inReplyTo)
- Method Detail
  - public int getPreamble()
    
    Gets the preamble ID.
    Returns:
    preamble ID
  - public java.lang.Integer getTxDuration()
    
    Gets reception duration.
    Returns:
    estimated duration us, null if unavailable
  - public java.lang.Long getTxStartTime()
    
    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 void setPreamble(int preamble)
    
    Sets the preamble ID.
    Parameters:
    preamble - preamble ID
  - public void setTxDuration(java.lang.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 setTxStartTime(java.lang.Long time)
    
    Sets the transmission timestamp in us.
    Parameters:
    time - timestamp in us.
  - public void setTxStartTime(long time)
    
    Sets the transmission timestamp in us.
    Parameters:
    time - timestamp in us.
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class TxStartNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int preamble

protected java.lang.Integer txDuration

protected java.lang.Long txStartTime

Property Detail

int preamble

java.lang.Integer txDuration

java.lang.Long txStartTime

Constructor Detail

public TxStartNtf()

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

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

public TxStartNtf(org.arl.fjage.AgentID recipient, org.arl.fjage.Message inReplyTo)

Method Detail

public int getPreamble()

public java.lang.Integer getTxDuration()

public java.lang.Long getTxStartTime()

public void setPreamble(int preamble)

public void setTxDuration(java.lang.Integer duration)

public void setTxDuration(int duration)

public void setTxStartTime(java.lang.Long time)

public void setTxStartTime(long time)

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