Struct SRPhotoplethysmogramOpticalSample

Source

pub struct SRPhotoplethysmogramOpticalSample { /* private fields */ }

Expand description

Apple’s documentation

Implementations§

Source §

pub unsafe fn emitter(&self) -> NSInteger

The index of the LED in use during the sample reading

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn activePhotodiodeIndexes(&self) -> Retained<NSIndexSet>

The set of photodiodes in use during the sample reading

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn signalIdentifier(&self) -> NSInteger

identifier to distinguish between different signals produced using the same photodiodes and emitters

To provide the same quality of service certain system conditions may require configuring the PPG sensor behavior differently while using the same photodiodes and emitters. This identifier can be used distinguish between the different signals generated by these different configurations.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn nominalWavelength(&self) -> Retained<NSMeasurement<NSUnitLength>>

the wavelength in nanometers the emitter was designed to produce while operating at a specific temperature

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn effectiveWavelength( &self, ) -> Retained<NSMeasurement<NSUnitLength>>

a temperature compensated wavelength in nanometers estimate that the emitter is producing

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn samplingFrequency( &self, ) -> Retained<NSMeasurement<NSUnitFrequency>>

Sampling frequency of PPG data in Hz

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn nanosecondsSinceStart(&self) -> i64

nanoseconds since the SRPhotoplethysmogramSamplestart date of the specific optical sample

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn normalizedReflectance(&self) -> Option<Retained<NSNumber>>

The PPG waveform

This may be nilwhen the sensor data reading is invalid

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn whiteNoise(&self) -> Option<Retained<NSNumber>>

White noise estimation

This may be nilwhen the sensor data reading is invalid

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn pinkNoise(&self) -> Option<Retained<NSNumber>>

Pink noise estimation

This may be nilwhen the sensor data reading is invalid

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn backgroundNoise(&self) -> Option<Retained<NSNumber>>

Estimated ambient noise intrusion

This may be nilwhen the sensor data reading is invalid

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn backgroundNoiseOffset(&self) -> Option<Retained<NSNumber>>

Estimated electronics noise floor level of the sensor

To estimate the total ambient noise, subtract scaled background noise offset from the background noise. The scaling factor can be computed based on the researcher’s digital filter setup. This may be nilwhen the sensor data reading is invalid

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn conditions( &self, ) -> Retained<NSArray<SRPhotoplethysmogramOpticalSampleCondition>>

Flags indicating sensor context or conditions that may effect the sample reading

These flags can provide some indication of data validity or other system conditions that may influence how the recorded data should be treated.

This property is not atomic.

§Safety

This might not be thread-safe.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}