RecordBasebandSignalReq (unet-framework 7.0.0 API)

org.arl.unet.bb.RecordBasebandSignalReq

Baseband recording request. This request can be sent to an agent that supports baseband recording (Services.BASEBAND service).

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.Integer`	`recLength`
`protected java.lang.Long`	`recStartTime`

Properties Summary

Properties
Type	Name and description
`java.lang.Integer`	`recLength`
`java.lang.Long`	`recStartTime`

Constructor Summary

Constructors
Constructor and description
`RecordBasebandSignalReq ()` Create a recording request for a the nominal number of samples supported.
`RecordBasebandSignalReq (int len)` Create a recording request for a specified number of samples.
`RecordBasebandSignalReq (org.arl.fjage.AgentID recipient, int len)` Create a recording request for a specified number of samples.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Integer`	`getRecLength()` Gets the length of the recording in samples.
	`java.lang.Long`	`getRecStartTime()` Gets the time at which recording should start.
	`void`	`setRecLength(java.lang.Integer len)` Sets recording length in samples.
	`void`	`setRecStartTime(java.lang.Long time)` Sets recording time.
	`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 java.lang.Integer recLength
  - protected java.lang.Long recStartTime
- Property Detail
  - java.lang.Integer recLength
  - java.lang.Long recStartTime
- Constructor Detail
  - public RecordBasebandSignalReq()
    
    Create a recording request for a the nominal number of samples supported.
  - public RecordBasebandSignalReq(int len)
    
    Create a recording request for a specified number of samples.
    Parameters:
    len - number of samples to record
  - public RecordBasebandSignalReq(org.arl.fjage.AgentID recipient, int len)
    
    Create a recording request for a specified number of samples.
    Parameters:
    recipient - agent to send the request to
    len - number of samples to record
- Method Detail
  - public java.lang.Integer getRecLength()
    
    Gets the length of the recording in samples.
    Returns:
    recording length (null if unspecified)
  - public java.lang.Long getRecStartTime()
    
    Gets the time at which recording should start. Zero or negative timestamps are considered relative.
    Returns:
    recording timestamp in us, if specified, null otherwise
  - public void setRecLength(java.lang.Integer len)
    
    Sets recording length in samples.
    Parameters:
    len - recording length in samples, null if unspecified (nominal length supported)
  - public void setRecStartTime(java.lang.Long time)
    
    Sets recording time. Recording will be triggered at the specified time. Zero or negative timestamps are considered relative.
    Parameters:
    time - recording time in us, or null
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class RecordBasebandSignalReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.Integer recLength

protected java.lang.Long recStartTime

Property Detail

java.lang.Integer recLength

java.lang.Long recStartTime

Constructor Detail

public RecordBasebandSignalReq()

public RecordBasebandSignalReq(int len)

public RecordBasebandSignalReq(org.arl.fjage.AgentID recipient, int len)

Method Detail

public java.lang.Integer getRecLength()

public java.lang.Long getRecStartTime()

public void setRecLength(java.lang.Integer len)

public void setRecStartTime(java.lang.Long time)

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