1 /*
2 * Copyright (C) 2018 Alberto Irurueta Carro (alberto@irurueta.com)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.irurueta.navigation.indoor;
17
18 import java.io.Serializable;
19
20 /**
21 * Interface defining any radio source (e.g. Wi-Fi access point or Bluetooth beacon).
22 */
23 public interface RadioSource extends Serializable {
24
25 /**
26 * Gets frequency used by this radio source (expressed in Hz).
27 *
28 * @return frequency used by this radio source (expressed in Hz).
29 */
30 double getFrequency();
31
32 /**
33 * Checks whether two radio sources are considered equal if they share the same identifiers.
34 *
35 * @param obj radio source to be compared.
36 * @return true if both radio sources are considered equal, false otherwise.
37 */
38 boolean equals(final Object obj);
39
40 /**
41 * Gets radio source type, which can be either a Wi-Fi Access point or a bluetooth Beacon.
42 *
43 * @return radio source type.
44 */
45 RadioSourceType getType();
46 }