diff options
Diffstat (limited to 'SmartDeviceLink/public/SDLBodyInformation.h')
| -rw-r--r-- | SmartDeviceLink/public/SDLBodyInformation.h | 81 |
1 files changed, 64 insertions, 17 deletions
diff --git a/SmartDeviceLink/public/SDLBodyInformation.h b/SmartDeviceLink/public/SDLBodyInformation.h index bed364503..081033a1d 100644 --- a/SmartDeviceLink/public/SDLBodyInformation.h +++ b/SmartDeviceLink/public/SDLBodyInformation.h @@ -5,17 +5,36 @@ #import "SDLIgnitionStableStatus.h" #import "SDLIgnitionStatus.h" +#import "SDLRPCStruct.h" - -/** - * The body information including power modes. - */ +@class SDLDoorStatus; +@class SDLGateStatus; +@class SDLRoofStatus; NS_ASSUME_NONNULL_BEGIN @interface SDLBodyInformation : SDLRPCStruct /** + * @param parkBrakeActive - @(parkBrakeActive) + * @param ignitionStableStatus - ignitionStableStatus + * @param ignitionStatus - ignitionStatus + * @return A SDLBodyInformation object + */ +- (instancetype)initWithParkBrakeActive:(BOOL)parkBrakeActive ignitionStableStatus:(SDLIgnitionStableStatus)ignitionStableStatus ignitionStatus:(SDLIgnitionStatus)ignitionStatus; + +/** + * @param parkBrakeActive - @(parkBrakeActive) + * @param ignitionStableStatus - ignitionStableStatus + * @param ignitionStatus - ignitionStatus + * @param doorStatuses - doorStatuses + * @param gateStatuses - gateStatuses + * @param roofStatuses - roofStatuses + * @return A SDLBodyInformation object + */ +- (instancetype)initWithParkBrakeActive:(BOOL)parkBrakeActive ignitionStableStatus:(SDLIgnitionStableStatus)ignitionStableStatus ignitionStatus:(SDLIgnitionStatus)ignitionStatus doorStatuses:(nullable NSArray<SDLDoorStatus *> *)doorStatuses gateStatuses:(nullable NSArray<SDLGateStatus *> *)gateStatuses roofStatuses:(nullable NSArray<SDLRoofStatus *> *)roofStatuses; + +/** * References signal "PrkBrkActv_B_Actl". Required @@ -37,32 +56,60 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLIgnitionStatus ignitionStatus; /** - * References signal "DrStatDrv_B_Actl". - - Optional + * References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0. + * + * @deprecated in SmartDeviceLink 7.1.0 + * @added in SmartDeviceLink 2.0.0 */ -@property (nullable, strong, nonatomic) NSNumber<SDLBool> *driverDoorAjar; +@property (nullable, strong, nonatomic) NSNumber<SDLBool> *driverDoorAjar __deprecated_msg("use doorStatuses instead"); /** - * References signal "DrStatPsngr_B_Actl". + * References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0. + * + * @deprecated in SmartDeviceLink 7.1.0 + * @added in SmartDeviceLink 2.0.0 + */ +@property (nullable, strong, nonatomic) NSNumber<SDLBool> *passengerDoorAjar __deprecated_msg("use doorStatuses instead"); - Optional +/** + * References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0. + * + * @deprecated in SmartDeviceLink 7.1.0 + * @added in SmartDeviceLink 2.0.0 */ -@property (nullable, strong, nonatomic) NSNumber<SDLBool> *passengerDoorAjar; +@property (nullable, strong, nonatomic) NSNumber<SDLBool> *rearLeftDoorAjar __deprecated_msg("use doorStatuses instead"); /** - * References signal "DrStatRl_B_Actl". + * References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0. + * + * @deprecated in SmartDeviceLink 7.1.0 + * @added in SmartDeviceLink 2.0.0 + */ +@property (nullable, strong, nonatomic) NSNumber<SDLBool> *rearRightDoorAjar __deprecated_msg("use doorStatuses instead"); - Optional +/** + * Provides status for doors if Ajar/Closed/Locked + * {"array_min_size": 0, "array_max_size": 100} + * + * @added in SmartDeviceLink 7.1.0 */ -@property (nullable, strong, nonatomic) NSNumber<SDLBool> *rearLeftDoorAjar; +@property (nullable, strong, nonatomic) NSArray<SDLDoorStatus *> *doorStatuses; /** - * References signal "DrStatRr_B_Actl". + * Provides status for trunk/hood/etc. if Ajar/Closed/Locked + * {"array_min_size": 0, "array_max_size": 100} + * + * @added in SmartDeviceLink 7.1.0 + */ +@property (nullable, strong, nonatomic) NSArray<SDLGateStatus *> *gateStatuses; - Optional +/** + * Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed etc. + * {"array_min_size": 0, "array_max_size": 100} + * + * @added in SmartDeviceLink 7.1.0 */ -@property (nullable, strong, nonatomic) NSNumber<SDLBool> *rearRightDoorAjar; +@property (nullable, strong, nonatomic) NSArray<SDLRoofStatus *> *roofStatuses; @end |