VehicleProperty Class Reference

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
	Various property types: More...
static const Property	VehicleSpeed
static const Property	EngineSpeed
static const Property	TransmissionShiftPosition
static const Property	ThrottlePosition
static const Property	WheelBrake
static const Property	WheelBrakePressure
static const Property	SteeringWheelAngle
static const Property	SteeringWheelAngleW3C
	TODO: Rename to "SteeringWheel" in 0.14. More...
static const Property	TurnSignal
static const Property	ClutchStatus
static const Property	EngineOilPressure
static const Property	EngineCoolantTemperature
static const Property	EngineCoolantLevel
static const Property	MachineGunTurretStatus
static const Property	AccelerationX
static const Property	AccelerationY
static const Property	AccelerationZ
static const Property	MassAirFlow
static const Property	ButtonEvent
	TODO: deprecated. Use ButtonEventW3C. Remove in 0.14. More...
static const Property	ButtonEventW3C
static const Property	AirIntakeTemperature
static const Property	BatteryVoltage
static const Property	BatteryCurrent
static const Property	BatteryChargeLevel
static const Property	InteriorTemperature
static const Property	ExteriorTemperature
static const Property	EngineOilTemperature
static const Property	EngineOilRemaining
static const Property	EngineOilLifeRemaining
static const Property	EngineOilChangeIndicator
static const Property	VIN
static const Property	WMI
static const Property	TirePressure
static const Property	TirePressureLow
static const Property	TireTemperature
static const Property	VehiclePowerMode
static const Property	TripMeters
static const Property	CruiseControlActive
static const Property	CruiseControlSpeed
static const Property	LightHead
static const Property	LightRightTurn
static const Property	LightLeftTurn
static const Property	LightBrake
static const Property	LightFog
static const Property	LightHazard
static const Property	LightParking
static const Property	LightHighBeam
static const Property	LightAutomatic
static const Property	LightDynamicHighBeam
static const Property	InteriorLightDriver
	TODO: deprecated. Use InteriorLightStatus which is zoned. Remove in 0.14.
static const Property	InteriorLightCenter
	TODO: deprecated. Use InteriorLightStatus which is zoned. Remove in 0.14.
static const Property	InteriorLightPassenger
	TODO: deprecated. Use InteriorLightStatus which is zoned. Remove in 0.14.
static const Property	InteriorLightStatus
static const Property	EngineLoad
static const Property	Horn
static const Property	FuelLevel
static const Property	FuelRange
static const Property	FuelConsumption
static const Property	FuelEconomy
static const Property	FuelAverageEconomy
static const Property	FuelAverageConsumption
static const Property	FuelTimeSinceRestart
static const Property	FuelConsumptionSinceRestart
static const Property	FuelType
static const Property	FuelPositionSide
static const Property	ExteriorBrightness
static const Property	Latitude
static const Property	Longitude
static const Property	Altitude
static const Property	Direction
static const Property	VehicleWidth
static const Property	VehicleHeight
static const Property	VehicleLength
static const Property	VehicleType
static const Property	DoorsPerRow
static const Property	TransmissionGearType
static const Property	FrontWheelRadius
static const Property	RearWheelRadius
static const Property	WheelTrack
static const Property	BrakePressure
static const Property	Odometer
	TODO: deprecated. remove in 0.14. Use DistanceTotal.
static const Property	DistanceTotal
static const Property	DistanceSinceStart
static const Property	TransmissionFluidLevel
static const Property	TransmissionOilWear
static const Property	TransmissionOilTemperature
static const Property	TransmissionClutchWear
static const Property	BrakeFluidLevel
static const Property	WasherFluidLevel
static const Property	WasherFluidLevelLow
static const Property	SecurityAlertStatus
	TODO: Depreciated in 0.14. Use AlarmStatus. More...
static const Property	ParkingBrakeStatus
static const Property	ParkingBrakeStatusW3C
	ParkingBrakeStatusW3C use with ParkingBrake::W3C::*. More...
static const Property	ParkingLightStatus
static const Property	HazardLightStatus
static const Property	AntilockBrakingSystem
static const Property	AntilockBrakingSystemEnabled
static const Property	TractionControlSystem
static const Property	TractionControlSystemEnabled
static const Property	VehicleTopSpeedLimit
static const Property	AirbagStatus
	TODO: Deprecated in 0.14.
static const Property	AirbagActivated
static const Property	AirbagDeployed
static const Property	DoorStatus
	TODO: deprecate in 0.14. Use DoorStatusW3C.
static const Property	DoorStatusW3C
	DoorStatusW3C use with Door::W3C::*.
static const Property	DoorLockStatus
static const Property	ChildLockStatus
static const Property	SeatBeltStatus
static const Property	WindowLockStatus
static const Property	OccupantStatus
	TODO Deprecated in 0.14.
static const Property	OccupantStatusW3C
static const Property	ObstacleDistance
static const Property	RainSensor
static const Property	WindshieldWiper
	TODO Deprecated in 0.14. Use WinshieldWiperSpeed.
static const Property	WindshieldWiperSpeed
	WindshieldWiperSpeed Use WiperSpeedSetting::W3C::* for value.
static const Property	WindshieldWiperSetting
	WindshieldWiperSetting Use WiperSpeedSetting::W3C::* for value.
static const Property	AirflowDirection
	TODO: Deprecated. Remove in 0.14.
static const Property	AirflowDirectionW3C
static const Property	FanSpeed
static const Property	TargetTemperature
static const Property	AirConditioning
static const Property	AirRecirculation
static const Property	Heater
static const Property	Defrost
	TODO: deprecated. remove in 0.14.
static const Property	DefrostWindow
static const Property	DefrostMirror
static const Property	SteeringWheelHeater
static const Property	SeatHeater
static const Property	SeatCooler
static const Property	WindowStatus
static const Property	Sunroof
static const Property	SunroofTilt
static const Property	ConvertibleRoof
static const Property	ConvertibleRoofStatus
	ConvertibleRoofStatus use with ConvertibleRoofW3C::*.
static const Property	NightMode
static const Property	DrivingMode
static const Property	DrivingModeW3C
static const Property	KeyId
static const Property	Language
static const Property	MeasurementSystem
static const Property	MirrorSettingPan
static const Property	MirrorSettingTilt
static const Property	SteeringWheelPositionSlide
static const Property	SteeringWheelPositionTilt
static const Property	SeatPositionRecline
static const Property	SeatPositionSlide
static const Property	SeatPositionCushionHeight
static const Property	SeatPositionHeadrest
static const Property	SeatPositionBackCushion
static const Property	SeatPositionSideCushion
static const Property	DashboardIllumination
static const Property	GeneratedVehicleSoundMode
static const Property	DriverId
static const Property	PowertrainTorque
static const Property	AcceleratorPedalPosition
static const Property	Chime
static const Property	WheelTick
static const Property	IgnitionTimeOn
static const Property	IgnitionTimeOff
static const Property	YawRate
static const Property	BrakePadWear
static const Property	BrakeFluidLevelLow
static const Property	BrakesWorn
static const Property	MalfunctionIndicatorOn
static const Property	AccumulatedEngineRuntime
static const Property	DistanceSinceCodeCleared
static const Property	DistanceWithMILOn
static const Property	TimeRunMILOn
static const Property	TimeTroubleCodeClear
static const Property	VehicleDriveMode
static const Property	ActiveNoiseControlMode
static const Property	AvailableSounds
static const Property	EngineSoundEnhancementMode
static const Property	ElectronicStabilityControlEnabled
static const Property	ElectronicStabilityControlEngaged
static const Property	OccupantIdentificationType
static const Property	OccupantName
static const Property	AtmosphericPressure
static const Property	LaneDepartureStatus
static const Property	AlarmStatus
	AlarmStatus. Use with Security::W3C*.

Detailed Description

Examples:

/home/kev/src/automotive-message-broker/lib/abstractroutingengine.h, and /home/kev/src/automotive-message-broker/lib/vehicleproperty.h.

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

static PropertyList VehicleProperty::capabilities ( )

static

capabilities

END PROPERTIES

Returns

returns list of all registered properties

See also

VehicleProperty::registerProperty

static 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 Property VehicleProperty::AccelerationZ

static

Mass Air Flow. grams/sec

const Property VehicleProperty::BatteryChargeLevel

static

Interior Air Temperature in degrees celcius

const Property VehicleProperty::BatteryVoltage

static

< Battery voltage in volts

const Property VehicleProperty::BrakeFluidLevel

static

Washer Fluid Level 0-100%.

const Property VehicleProperty::ButtonEvent

static

TODO: deprecated. Use ButtonEventW3C. Remove in 0.14.

< Button Event

See also

ButtonEvents::ButtonEventType

const Property VehicleProperty::ClutchStatus

static

Oil pressure TODO: units

const Property VehicleProperty::DistanceSinceStart

static

Transmission Fluid Level 0-100%.

const Property VehicleProperty::EngineCoolantLevel

static

0=off, 1=on

const Property VehicleProperty::EngineOilChangeIndicator

static

Vehicle Identification Number (ISO 3779) 17 chars

const Property VehicleProperty::EngineOilPressure

static

Engine coolant temperature in degrees celcius

const Property VehicleProperty::EngineSpeed

static

< Engine Speed in rotations per minute

const Property VehicleProperty::NoValue

static

Various property types:

Vehicle Velocity in km/h

const Property VehicleProperty::ParkingBrakeStatusW3C

static

ParkingBrakeStatusW3C use with ParkingBrake::W3C::*.

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

const Property VehicleProperty::ParkingLightStatus

static

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

const Property VehicleProperty::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 Property VehicleProperty::SteeringWheelAngle

static

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

const Property VehicleProperty::SteeringWheelAngleW3C

static

TODO: Rename to "SteeringWheel" in 0.14.

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

const Property VehicleProperty::TirePressure

static

< Tire pressure in kPa Tire pressure low

const Property VehicleProperty::TirePressureLow

static

Tire temperature in degrees C

const Property VehicleProperty::TireTemperature

static

Vehicle Power Mode.

See also

Power::Modes

const Property VehicleProperty::TransmissionClutchWear

static

Brake Fluid Level 0-100%.

const Property VehicleProperty::TransmissionShiftPosition

static

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

const Property VehicleProperty::TurnSignal

static

Clutch pedal status 0=off, 1=on

const Property VehicleProperty::WheelBrake

static

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

const Property VehicleProperty::WMI

static

< World Manufacturer Identifier (SAE) 3 characters.

---

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

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