TxFrameReq (unet-framework 7.0.0 API)

org.arl.unet.phy.TxFrameReq

Request message to transmit a frame using physical agent.

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`timestamped`
`protected java.lang.Long`	`txStartTime`
`protected int`	`type`
`protected boolean`	`wakeup`

Properties Summary

Properties
Type	Name and description
`boolean`	`timestamped`
`java.lang.Long`	`txStartTime`
`int`	`type`

Constructor Summary

Constructors
Constructor and description
`TxFrameReq ()`
`TxFrameReq (DatagramReq req)` Constructs TxFrameReq from a DatagramReq.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Long`	`getTxStartTime()` Gets the time at which it needs to be transmitted.
	`int`	`getType()` Gets the type of channel.
	`boolean`	`getWakeup()` Checks whether a wakeup signal should be sent before the frame.
	`boolean`	`isTimestamped()` Checks if transmission request needs to be timestamped PhysicalCapability.TIMESTAMPED_TX.
	`void`	`setTimestamped(boolean enabled)` Sets true if transmission request needs to be timestamped.
	`void`	`setTxStartTime(java.lang.Long time)` Sets transmission timestamp. transmission will be triggered at the specified time.
	`void`	`setType(int type)` Sets the channel type.
	`void`	`setWakeup(boolean enabled)` Enables/disables sending of wakeup signal before frame.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DatagramReq`	setData, getData, getProgress, toString, setPriority, getPriority, getProtocol, setProtocol, getReliability, setReliability, getRobustness, setRobustness, getShortcircuit, setShortcircuit, setProgress, getTo, getRoute, setTo, setTtl, getTtl, setRoute, setPerformative, getPerformative, setRecipient, getRecipient, setSender, getSender, setMessageID, getMessageID, setInReplyTo, getInReplyTo, setSentAt, getSentAt, getJsonCache, setJsonCache, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Field Detail
  - protected boolean timestamped
  - protected java.lang.Long txStartTime
  - protected int type
  - protected boolean wakeup
- Property Detail
  - boolean timestamped
  - java.lang.Long txStartTime
  - int type
- Constructor Detail
  - public TxFrameReq()
  - public TxFrameReq(DatagramReq req)
    
    Constructs TxFrameReq from a DatagramReq.
    Parameters:
    req - DatagramReq messsage
- Method Detail
  - public java.lang.Long getTxStartTime()
    
    Gets the time at which it needs to be transmitted.
    Returns:
    transmission timestamp in us if specified, null otherwise
  - public int getType()
    
    Gets the type of channel.
    Returns:
    type of channel (Physical.DATA or Physical.CONTROL)
  - public boolean getWakeup()
    
    Checks whether a wakeup signal should be sent before the frame.
    Returns:
    true to send wakeup signal, false otherwise
  - public boolean isTimestamped()
    
    Checks if transmission request needs to be timestamped PhysicalCapability.TIMESTAMPED_TX.
    Returns:
    true if a timestamped frame
  - public void setTimestamped(boolean enabled)
    
    Sets true if transmission request needs to be timestamped.
    Parameters:
    enabled - true if timestamped frame
  - public void setTxStartTime(java.lang.Long time)
    
    Sets transmission timestamp. transmission will be triggered at the specified time. PhysicalCapability.TIMED_TX
    Parameters:
    time - transmission time in us, or null
  - public void setType(int type)
    
    Sets the channel type.
    Parameters:
    type - of channel (Physical.DATA or Physical.CONTROL)
  - public void setWakeup(boolean enabled)
    
    Enables/disables sending of wakeup signal before frame.
    Parameters:
    enabled - true if wakeup signal to be sent
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class TxFrameReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected boolean timestamped

protected java.lang.Long txStartTime

protected int type

protected boolean wakeup

Property Detail

boolean timestamped

java.lang.Long txStartTime

int type

Constructor Detail

public TxFrameReq()

public TxFrameReq(DatagramReq req)

Method Detail

public java.lang.Long getTxStartTime()

public int getType()

public boolean getWakeup()

public boolean isTimestamped()

public void setTimestamped(boolean enabled)

public void setTxStartTime(java.lang.Long time)

public void setType(int type)

public void setWakeup(boolean enabled)

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