Loading...
Searching...
No Matches
org.wpilib.units.FrequencyUnit Class Reference
Inheritance diagram for org.wpilib.units.FrequencyUnit:
Public Member Functions | |
| FrequencyUnit | getBaseUnit () |
| Frequency | of (double magnitude) |
| Frequency | ofBaseUnits (double baseUnitMagnitude) |
| Frequency | zero () |
| Frequency | one () |
| VelocityUnit< FrequencyUnit > | per (TimeUnit time) |
| double | convertFrom (double magnitude, FrequencyUnit otherUnit) |
| Public Member Functions inherited from org.wpilib.units.PerUnit< DimensionlessUnit, TimeUnit > | |
| PerUnit< N, D > | getBaseUnit () |
| N | numerator () |
| D | denominator () |
| PerUnit< D, N > | reciprocal () |
| N | mult (D denom) |
| Measure<? extends PerUnit< N, D > > | of (double magnitude) |
| Measure<? extends PerUnit< N, D > > | ofBaseUnits (double baseUnitMagnitude) |
| final Per< N, D > | ofNative (double magnitude) |
| final Per< N, D > | ofNativeBaseUnits (double baseUnitMagnitude) |
| Measure<? extends PerUnit< N, D > > | zero () |
| Measure<? extends PerUnit< N, D > > | one () |
| Unit | per (TimeUnit time) |
| double | convertFrom (double magnitude, PerUnit<? extends N, ? extends D > otherUnit) |
| boolean | equals (Object o) |
| int | hashCode () |
Static Public Member Functions | |
| static FrequencyUnit | combine (DimensionlessUnit dim, TimeUnit period) |
| static FrequencyUnit | inverse (TimeUnit time) |
| Static Public Member Functions inherited from org.wpilib.units.PerUnit< DimensionlessUnit, TimeUnit > | |
| static< N extends Unit, D extends Unit > PerUnit< N, D > | combine (N numerator, D denominator) |
Detailed Description
A unit of frequency like org.wpilib.units.Units#Hertz.
Definition at line 12 of file FrequencyUnit.java.
Member Function Documentation
◆ combine()
|
static |
Combines a dimensionless unit and a cycle period to create a frequency.
- Parameters
-
dim the dimensionless unit period the unit of time
- Returns
- the combined unit of frequency
Definition at line 41 of file FrequencyUnit.java.
◆ convertFrom()
| double org.wpilib.units.FrequencyUnit.convertFrom | ( | double | magnitude, |
| FrequencyUnit | otherUnit ) |
Converts a measurement value in terms of another unit to this unit.
- Parameters
-
magnitude the magnitude of the measurement in terms of the other unit otherUnit the other unit
- Returns
- the value of the measurement in terms of this unit
Definition at line 104 of file FrequencyUnit.java.
◆ getBaseUnit()
| FrequencyUnit org.wpilib.units.FrequencyUnit.getBaseUnit | ( | ) |
Definition at line 46 of file FrequencyUnit.java.
◆ inverse()
|
static |
Inverts a unit of time to get its corresponding frequency (as if the unit of time is the period of the frequency).
- Parameters
-
time period of the associated frequency
- Returns
- the frequency associated with the period
Definition at line 57 of file FrequencyUnit.java.
◆ of()
| Frequency org.wpilib.units.FrequencyUnit.of | ( | double | magnitude | ) |
Definition at line 62 of file FrequencyUnit.java.
◆ ofBaseUnits()
| Frequency org.wpilib.units.FrequencyUnit.ofBaseUnits | ( | double | baseUnitMagnitude | ) |
Definition at line 67 of file FrequencyUnit.java.
◆ one()
| Frequency org.wpilib.units.FrequencyUnit.one | ( | ) |
Definition at line 77 of file FrequencyUnit.java.
◆ per()
| VelocityUnit< FrequencyUnit > org.wpilib.units.FrequencyUnit.per | ( | TimeUnit | time | ) |
Definition at line 82 of file FrequencyUnit.java.
◆ zero()
| Frequency org.wpilib.units.FrequencyUnit.zero | ( | ) |
Definition at line 72 of file FrequencyUnit.java.
The documentation for this class was generated from the following file:
- org/wpilib/units/FrequencyUnit.java
