Struct google_spectrum1_explorer::api::PawsGetSpectrumRequest

pub struct PawsGetSpectrumRequest {
    pub antenna: Option<AntennaCharacteristics>,
    pub capabilities: Option<DeviceCapabilities>,
    pub device_desc: Option<DeviceDescriptor>,
    pub location: Option<GeoLocation>,
    pub master_device_desc: Option<DeviceDescriptor>,
    pub owner: Option<DeviceOwner>,
    pub request_type: Option<String>,
    pub type_: Option<String>,
    pub version: Option<String>,
}

The request message for the available spectrum query protocol which must include the device’s geolocation.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• get spectrum paws (request)

Fields

antenna: Option<AntennaCharacteristics>

Depending on device type and regulatory domain, the characteristics of the antenna may be required.

capabilities: Option<DeviceCapabilities>

The master device may include its device capabilities to limit the available-spectrum response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.

device_desc: Option<DeviceDescriptor>

When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for that device is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.

location: Option<GeoLocation>

The geolocation of the master device (a device with geolocation capability that makes an available spectrum request) is required whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability). The location must be the location of the radiation center of the master device’s antenna. To support mobile devices, a regulatory domain may allow the anticipated position of the master device to be given instead. If the location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error code if it does not support query by region.

master_device_desc: Option<DeviceDescriptor>

When an available spectrum request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device, which is provided in a separate parameter).

owner: Option<DeviceOwner>

Depending on device type and regulatory domain, device owner information may be included in an available spectrum request. This allows the device to register and get spectrum-availability information in a single request.

request_type: Option<String>

The request type parameter is an optional parameter that can be used to modify an available spectrum request, but its use depends on applicable regulatory rules. It may be used, for example, to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the deviceDesc parameter for the device on whose behalf the request is made is required.

type_: Option<String>

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, …).

Required field.

version: Option<String>

The PAWS version. Must be exactly 1.0.

Required field.

Trait Implementations

impl Clone for PawsGetSpectrumRequest

fn clone(&self) -> PawsGetSpectrumRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PawsGetSpectrumRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PawsGetSpectrumRequest

fn default() -> PawsGetSpectrumRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PawsGetSpectrumRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PawsGetSpectrumRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for PawsGetSpectrumRequest