Classes
class	ButtonEventW3CType

Public Types
typedef std::string	Property

typedef std::function < AbstractPropertyType *(void)>	PropertyTypeFactoryCallback
	PropertyTypeFactoryCallback callback used to construct a AbstractPropertyType for a property. More...

Public Member Functions
	PROPERTYTYPE (TransmissionShiftPosition, TransmissionShiftPositionType, BasicPropertyType< Transmission::TransmissionPositions >, Transmission::TransmissionPositions) static const Property TransmissionGearPosition

	PROPERTYTYPE (TransmissionGearPosition, TransmissionGearPositionType, BasicPropertyType< Transmission::TransmissionPositions >, Transmission::TransmissionPositions) static const Property TransmissionMode
	TODO: deprecate in 0.14. Replaced by Drive::Mode.

	PROPERTYTYPE (TransmissionMode, TransmissionModeType, BasicPropertyType< Transmission::Mode >, Transmission::Mode) static const Property TransmissionModeW3C

Static Public Member Functions
static void	factory ()
	factory constructs a static instance of VehicleProperty. This should be called once before VehicleProperty is used in the app

static PropertyList	capabilities ()
	capabilities More...

static PropertyList	customProperties ()
	customProperties More...

static AbstractPropertyType *	getPropertyTypeForPropertyNameValue (Property name, std::string value="")
	getPropertyTypeForPropertyNameValue returns an AbstractPropertyType* for the property name with the value specified by 'value'. Ownership of the returned AbstractPropertyType* is transfered to the caller.

static bool	registerProperty (Property name, PropertyTypeFactoryCallback factory)

Static Public Attributes
static const Property	NoValue = "NoValue"
	Various property types: More...

static const Property	VehicleSpeed = "VehicleSpeed"

static const Property	EngineSpeed = "EngineSpeed"

static const Property	TransmissionShiftPosition = "TransmissionShiftPosition"

static const Property	ThrottlePosition = "ThrottlePosition"

static const Property	WheelBrake = "WheelBrake"

static const Property	WheelBrakePressure = "WheelBrakePressure"

static const Property	SteeringWheelAngle = "SteeringWheelAngle"

static const Property	SteeringWheelAngleW3C = "SteeringWheelAngleW3C"
	TODO: Rename to "SteeringWheel" in 0.14. More...

static const Property	TurnSignal = "TurnSignal"

static const Property	ClutchStatus = "ClutchStatus"

static const Property	EngineOilPressure = "EngineOilPressure"

static const Property	EngineCoolantTemperature = "EngineCoolantTemperature"

static const Property	EngineCoolantLevel = "EngineCoolantLevel"

static const Property	MachineGunTurretStatus = "MachineGunTurretStatus"

static const Property	AccelerationX = "AccelerationX"

static const Property	AccelerationY = "AccelerationY"

static const Property	AccelerationZ = "AccelerationZ"

static const Property	MassAirFlow = "MassAirFlow"

static const Property	ButtonEvent = "ButtonEvent"
	TODO: deprecated. Use ButtonEventW3C. Remove in 0.14. More...

static const Property	ButtonEventW3C = "ButtonEventW3C"

static const Property	AirIntakeTemperature = "AirIntakeTemperature"

static const Property	BatteryVoltage = "BatteryVoltage"

static const Property	BatteryCurrent = "BatteryCurrent"

static const Property	BatteryChargeLevel = "BatteryChargeLevel"

static const Property	InteriorTemperature = "InteriorTemperature"

static const Property	ExteriorTemperature = "ExteriorTemperature"

static const Property	EngineOilTemperature = "EngineOilTemperature"

static const Property	EngineOilRemaining = "EngineOilRemaining"

static const Property	EngineOilLifeRemaining = "EngineOilLifeRemaining"

static const Property	EngineOilChangeIndicator = "EngineOilChangeIndicator"

static const Property	VIN = "VIN"

static const Property	WMI = "WMI"

static const Property	TirePressure = "TirePressure"

static const Property	TirePressureLow = "TirePressureLow"

static const Property	TireTemperature = "TireTemperature"

static const Property	VehiclePowerMode = "VehiclePowerMode"

static const Property	TripMeters = "TripMeters"

static const Property	CruiseControlActive = "CruiseControlActive"

static const Property	CruiseControlSpeed = "CruiseControlSpeed"

static const Property	LightHead = "LightHead"

static const Property	LightRightTurn = "LightRightTurn"

static const Property	LightLeftTurn = "LightLeftTurn"

static const Property	LightBrake = "LightBrake"

static const Property	LightFog = "LightFog"

static const Property	LightHazard = "LightHazard"

static const Property	LightParking = "LightParking"

static const Property	LightHighBeam = "LightHighBeam"

static const Property	LightAutomatic = "LightAutomatic"

static const Property	LightDynamicHighBeam = "LightDynamicHighBeam"

static const Property	InteriorLightDriver = "InteriorLightDriver"
	TODO: deprecated. Use InteriorLightStatus which is zoned. Remove in 0.14.

static const Property	InteriorLightCenter = "InteriorLightCenter"
	TODO: deprecated. Use InteriorLightStatus which is zoned. Remove in 0.14.

static const Property	InteriorLightPassenger = "InteriorLightPassenger"
	TODO: deprecated. Use InteriorLightStatus which is zoned. Remove in 0.14.

static const Property	InteriorLightStatus = "InteriorLightStatus"

static const Property	EngineLoad = "EngineLoad"

static const Property	Horn = "Horn"

static const Property	FuelLevel = "FuelLevel"

static const Property	FuelRange = "FuelRange"

static const Property	FuelConsumption = "FuelConsumption"

static const Property	FuelEconomy = "FuelEconomy"

static const Property	FuelAverageEconomy = "FuelAverageEconomy"

static const Property	FuelAverageConsumption = "FuelAverageConsumption"

static const Property	FuelTimeSinceRestart = "FuelTimeSinceRestart"

static const Property	FuelConsumptionSinceRestart = "FuelConsumptionSinceRestart"

static const Property	FuelType = "FuelType"

static const Property	FuelPositionSide = "FuelPositionSide"

static const Property	ExteriorBrightness = "ExteriorBrightness"

static const Property	Latitude = "Latitude"

static const Property	Longitude = "Longitude"

static const Property	Altitude = "Altitude"

static const Property	Direction = "Direction"

static const Property	VehicleWidth = "VehicleWidth"

static const Property	VehicleHeight = "VehicleHeight"

static const Property	VehicleLength = "VehicleLength"

static const Property	VehicleType = "VehicleType"

static const Property	DoorsPerRow = "DoorsPerRow"

static const Property	TransmissionGearType = "TransmissionGearType"

static const Property	FrontWheelRadius = "FrontWheelRadius"

static const Property	RearWheelRadius = "RearWheelRadius"

static const Property	WheelTrack = "WheelTrack"

static const Property	BrakePressure = "BrakePressure"

static const Property	Odometer = "Odometer"
	TODO: deprecated. remove in 0.14. Use DistanceTotal.

static const Property	DistanceTotal = "DistanceTotal"

static const Property	DistanceSinceStart = "DistanceSinceStart"

static const Property	TransmissionFluidLevel = "TransmissionFluidLevel"

static const Property	TransmissionOilWear = "TransmissionOilWear"

static const Property	TransmissionOilTemperature = "TransmissionOilTemperature"

static const Property	TransmissionClutchWear = "TransmissionClutchWear"

static const Property	BrakeFluidLevel = "BrakeFluidLevel"

static const Property	WasherFluidLevel = "WasherFluidLevel"

static const Property	WasherFluidLevelLow = "WasherFluidLevelLow"

static const Property	SecurityAlertStatus = "SecurityAlertStatus"
	TODO: Depreciated in 0.14. Use AlarmStatus. More...

static const Property	ParkingBrakeStatus = "ParkingBrakeStatus"

static const Property	ParkingBrakeStatusW3C = "ParkingBrakeStatusW3C"
	ParkingBrakeStatusW3C use with ParkingBrake::W3C::*. More...

static const Property	ParkingLightStatus = "ParkingLightStatus"

static const Property	HazardLightStatus = "HazardLightStatus"

static const Property	AntilockBrakingSystem = "AntilockBrakingSystem"

static const Property	AntilockBrakingSystemEnabled = "AntilockBrakingSystemEnabled"

static const Property	TractionControlSystem = "TractionControlSystem"

static const Property	TractionControlSystemEnabled = "TractionControlSystemEnabled"

static const Property	VehicleTopSpeedLimit = "VehicleTopSpeedLimit"

static const Property	AirbagStatus = "AirbagStatus"
	TODO: Deprecated in 0.14.

static const Property	AirbagActivated = "AirbagActivated"

static const Property	AirbagDeployed = "AirbagDeployed"

static const Property	DoorStatus = "DoorStatus"
	TODO: deprecate in 0.14. Use DoorStatusW3C.

static const Property	DoorStatusW3C = "DoorStatusW3C"
	DoorStatusW3C use with Door::W3C::*.

static const Property	DoorLockStatus = "DoorLockStatus"

static const Property	ChildLockStatus = "ChildLockStatus"

static const Property	SeatBeltStatus = "SeatBeltStatus"

static const Property	WindowLockStatus = "WindowLockStatus"

static const Property	OccupantStatus = "OccupantStatus"
	TODO Deprecated in 0.14.

static const Property	OccupantStatusW3C = "OccupantStatusW3C"

static const Property	ObstacleDistance = "ObstacleDistance"

static const Property	RainSensor = "RainSensor"

static const Property	WindshieldWiper = "WindshieldWiper"
	TODO Deprecated in 0.14. Use WinshieldWiperSpeed.

static const Property	WindshieldWiperSpeed = "WindshieldWiperSpeed"
	WindshieldWiperSpeed Use WiperSpeedSetting::W3C::* for value.

static const Property	WindshieldWiperSetting = "WindshieldWiperSetting"
	WindshieldWiperSetting Use WiperSpeedSetting::W3C::* for value.

static const Property	AirflowDirection = "AirflowDirection"
	TODO: Deprecated. Remove in 0.14.

static const Property	AirflowDirectionW3C = "AirflowDirectionW3C"

static const Property	FanSpeed = "FanSpeed"

static const Property	TargetTemperature = "TargetTemperature"

static const Property	AirConditioning = "AirConditioning"

static const Property	AirRecirculation = "AirRecirculation"

static const Property	Heater = "Heater"

static const Property	Defrost = "Defrost"
	TODO: deprecated. remove in 0.14.

static const Property	DefrostWindow = "DefrostWindow"

static const Property	DefrostMirror = "DefrostMirror"

static const Property	SteeringWheelHeater = "SteeringWheelHeater"

static const Property	SeatHeater = "SeatHeater"

static const Property	SeatCooler = "SeatCooler"

static const Property	WindowStatus = "WindowStatus"

static const Property	Sunroof = "Sunroof"

static const Property	SunroofTilt = "SunroofTilt"

static const Property	ConvertibleRoof = "ConvertibleRoof"

static const Property	ConvertibleRoofStatus = "ConvertibleRoofStatus"
	ConvertibleRoofStatus use with ConvertibleRoofW3C::*.

static const Property	NightMode = "NightMode"

static const Property	DrivingMode = "DrivingMode"

static const Property	DrivingModeW3C = "DrivingModeW3C"

static const Property	KeyId = "KeyId"

static const Property	Language = "Language"

static const Property	MeasurementSystem = "MeasurementSystem"

static const Property	MirrorSettingPan = "MirrorSettingPan"

static const Property	MirrorSettingTilt = "MirrorSettingTilt"

static const Property	SteeringWheelPositionSlide = "SteeringWheelPositionSlide"

static const Property	SteeringWheelPositionTilt = "SteeringWheelPositionTilt"

static const Property	SeatPositionRecline = "SeatPositionRecline"

static const Property	SeatPositionSlide = "SeatPositionSlide"

static const Property	SeatPositionCushionHeight = "SeatPositionCushionHeight"

static const Property	SeatPositionHeadrest = "SeatPositionHeadrest"

static const Property	SeatPositionBackCushion = "SeatPositionBackCushion"

static const Property	SeatPositionSideCushion = "SeatPositionSideCushion"

static const Property	DashboardIllumination = "DashboardIllumination"

static const Property	GeneratedVehicleSoundMode = "GeneratedVehicleSoundMode"

static const Property	DriverId = "DriverId"

static const Property	PowertrainTorque = "PowertrainTorque"

static const Property	AcceleratorPedalPosition = "AcceleratorPedalPosition"

static const Property	Chime = "Chime"

static const Property	WheelTick = "WheelTick"

static const Property	IgnitionTimeOn = "IgnitionTimeOn"

static const Property	IgnitionTimeOff = "IgnitionTimeOff"

static const Property	YawRate = "YawRate"

static const Property	BrakePadWear = "BrakePadWear"

static const Property	BrakeFluidLevelLow = "BrakeFluidLevelLow"

static const Property	BrakesWorn

static const Property	MalfunctionIndicatorOn = "MalfunctionIndicatorOn"

static const Property	AccumulatedEngineRuntime = "AccumulatedEngineRuntime"

static const Property	DistanceSinceCodeCleared = "DistanceSinceCodeCleared"

static const Property	DistanceWithMILOn = "DistanceWithMILOn"

static const Property	TimeRunMILOn = "TimeRunMILOn"

static const Property	TimeTroubleCodeClear = "TimeTroubleCodeClear"

static const Property	VehicleDriveMode = "VehicleDriveMode"

static const Property	ActiveNoiseControlMode = "ActiveNoiseControlMode"

static const Property	AvailableSounds = "AvailableSounds"

static const Property	EngineSoundEnhancementMode = "EngineSoundEnhancementMode"

static const Property	ElectronicStabilityControlEnabled = "ElectronicStabilityControlEnabled"

static const Property	ElectronicStabilityControlEngaged = "ElectronicStabilityControlEngaged"

static const Property	OccupantIdentificationType = "OccupantIdentificationType"

static const Property	OccupantName = "OccupantName"

static const Property	AtmosphericPressure = "AtmosphericPressure"

static const Property	LaneDepartureStatus = "LaneDepartureStatus"

static const Property	AlarmStatus = "AlarmStatus"
	AlarmStatus. Use with Security::W3C*.

Member Typedef Documentation

typedef std::function<AbstractPropertyType* (void)> VehicleProperty::PropertyTypeFactoryCallback

PropertyTypeFactoryCallback callback used to construct a AbstractPropertyType for a property.

See also: registerProperty

Member Function Documentation

PropertyList VehicleProperty::capabilities ( )

static

capabilities

END PROPERTIES

Returns: returns list of all registered properties

See also: VehicleProperty::registerProperty

PropertyList VehicleProperty::customProperties ( )

static

customProperties

Returns: returns list of custom properties defined by plugins using VehicleProperty::registerProperty

VehicleProperty::PROPERTYTYPE	(	TransmissionShiftPosition	,
		TransmissionShiftPositionType	,
		BasicPropertyType< Transmission::TransmissionPositions >	,
		Transmission::TransmissionPositions
	)		const

< Transmission Gear Position 0 = Neutral 1 = 1st 2 = 2nd ... 64 = CVT 128 = Reverse

VehicleProperty::PROPERTYTYPE	(	TransmissionMode	,
		TransmissionModeType	,
		BasicPropertyType< Transmission::Mode >	,
		Transmission::Mode
	)		const

< TransmissionModeW3C see Transmission::W3C::Park, Transmission::W3C::Drive, etcThrottle position 0-100%

Member Data Documentation

const VehicleProperty::Property VehicleProperty::AccelerationZ = "AccelerationZ"

static

Mass Air Flow. grams/sec

const VehicleProperty::Property VehicleProperty::BatteryChargeLevel = "BatteryChargeLevel"

static

Interior Air Temperature in degrees celcius

const VehicleProperty::Property VehicleProperty::BatteryVoltage = "BatteryVoltage"

static

< Battery voltage in volts

const VehicleProperty::Property VehicleProperty::BrakeFluidLevel = "BrakeFluidLevel"

static

Washer Fluid Level 0-100%.

const VehicleProperty::Property VehicleProperty::ButtonEvent = "ButtonEvent"

static

TODO: deprecated. Use ButtonEventW3C. Remove in 0.14.

< Button Event

See also: ButtonEvents::ButtonEventType

const VehicleProperty::Property VehicleProperty::ClutchStatus = "ClutchStatus"

static

Oil pressure TODO: units

const VehicleProperty::Property VehicleProperty::DistanceSinceStart = "DistanceSinceStart"

static

Transmission Fluid Level 0-100%.

const VehicleProperty::Property VehicleProperty::EngineCoolantLevel = "EngineCoolantLevel"

static

0=off, 1=on

const VehicleProperty::Property VehicleProperty::EngineOilChangeIndicator = "EngineOilChangeIndicator"

static

Vehicle Identification Number (ISO 3779) 17 chars

const VehicleProperty::Property VehicleProperty::EngineOilPressure = "EngineOilPressure"

static

Engine coolant temperature in degrees celcius

const VehicleProperty::Property VehicleProperty::EngineSpeed = "EngineSpeed"

static

< Engine Speed in rotations per minute

const VehicleProperty::Property VehicleProperty::NoValue = "NoValue"

static

Various property types:

Vehicle Velocity in km/h

const VehicleProperty::Property VehicleProperty::ParkingBrakeStatusW3C = "ParkingBrakeStatusW3C"

static

ParkingBrakeStatusW3C use with ParkingBrake::W3C::*.

Parking Light Status status of parking lights active (true) or inactive (false)

const VehicleProperty::Property VehicleProperty::ParkingLightStatus = "ParkingLightStatus"

static

Hazard Lights Status status of parking lights active (true) or inactive (false)

const VehicleProperty::Property VehicleProperty::SecurityAlertStatus = "SecurityAlertStatus"

static

TODO: Depreciated in 0.14. Use AlarmStatus.

Parking Brake Status status of parking break active (true) or inactive (false) TODO: Deprecated in 0.14.

const VehicleProperty::Property VehicleProperty::SteeringWheelAngle = "SteeringWheelAngle"

static

< Steering wheel angle (0-359) TODO: Deprecate in 0.14. Replace with SteeringWheelAngleW3C

const VehicleProperty::Property VehicleProperty::SteeringWheelAngleW3C = "SteeringWheelAngleW3C"

static

TODO: Rename to "SteeringWheel" in 0.14.

0=off, 1=right, 2=left, 3=hazard

const VehicleProperty::Property VehicleProperty::TirePressure = "TirePressure"

static

< Tire pressure in kPa Tire pressure low

const VehicleProperty::Property VehicleProperty::TirePressureLow = "TirePressureLow"

static

Tire temperature in degrees C

const VehicleProperty::Property VehicleProperty::TireTemperature = "TireTemperature"

static

Vehicle Power Mode.

See also: Power::Modes

const VehicleProperty::Property VehicleProperty::TransmissionClutchWear = "TransmissionClutchWear"

static

Brake Fluid Level 0-100%.

const VehicleProperty::Property VehicleProperty::TransmissionShiftPosition = "TransmissionShiftPosition"

static

< Transmission Shift Position 0 = Neutral 1 = 1st 2 = 2nd ... 96 = Drive 128 = Reverse 255 = Park

const VehicleProperty::Property VehicleProperty::TurnSignal = "TurnSignal"

static

Clutch pedal status 0=off, 1=on

const VehicleProperty::Property VehicleProperty::WheelBrake = "WheelBrake"

static

< Wheel brake position. Engaged = true, Idle = false

const VehicleProperty::Property VehicleProperty::WMI = "WMI"

static

< World Manufacturer Identifier (SAE) 3 characters.

The documentation for this class was generated from the following files:

/home/kev/src/automotive-message-broker/lib/vehicleproperty.h
/home/kev/src/automotive-message-broker/lib/vehicleproperty.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Member Typedef Documentation

Member Function Documentation

Member Data Documentation