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.13. 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 void	shutdown ()
	destroys static instance of VehicleProperty. This should be called at application shutdown

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.13. 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"

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	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"

static const Property	InteriorLightCenter = "InteriorLightCenter"

static const Property	InteriorLightPassenger = "InteriorLightPassenger"

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.13. Use DistanceTotal.

static const Property	DistanceTotal = "DistanceTotal"

static const Property	DistanceSinceStart = "DistanceSinceStart"

static const Property	TransmissionFluidLevel = "TransmissionFluidLevel"

static const Property	BrakeFluidLevel = "BrakeFluidLevel"

static const Property	WasherFluidLevel = "WasherFluidLevel"

static const Property	SecurityAlertStatus = "SecurityAlertStatus"

static const Property	ParkingBrakeStatus = "ParkingBrakeStatus"

static const Property	ParkingLightStatus = "ParkingLightStatus"

static const Property	HazardLightStatus = "HazardLightStatus"

static const Property	AntilockBrakingSystem = "AntilockBrakingSystem"

static const Property	TractionControlSystem = "TractionControlSystem"

static const Property	VehicleTopSpeedLimit = "VehicleTopSpeedLimit"

static const Property	AirbagStatus = "AirbagStatus"

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

static const Property	DoorStatusW3C = "DoorStatusW3C"

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"

static const Property	ObstacleDistance = "ObstacleDistance"

static const Property	RainSensor = "RainSensor"

static const Property	WindshieldWiper = "WindshieldWiper"

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

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.13.

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	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 = "MirrorPanSetting"

static const Property	MirrorSettingTilt = "MirrorTiltSetting"

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"

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::AccelerationX = "AccelerationX"

static

Acceleration on the 'y' axis in 1/1000 gravitational acceleration "g-force"

const VehicleProperty::Property VehicleProperty::AccelerationY = "AccelerationY"

static

Acceleration on the 'z' axis in 1/1000 gravitational acceleration "g-force"

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

static

Mass Air Flow. grams/sec

const VehicleProperty::Property VehicleProperty::AirIntakeTemperature = "AirIntakeTemperature"

static

< Air intake temperature in degrees celcius

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

< Brake Fluid Level 0-100%.

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

static

< 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::DoorStatusW3C = "DoorStatusW3C"

static

use with Door::W3C::*

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

static

0=off, 1=on

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

static

Engine coolant temperature in degrees celcius

const VehicleProperty::Property VehicleProperty::EngineOilTemperature = "EngineOilTemperature"

static

< Engine Oil Temperature in degrees celcius

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

static

< Engine Speed in rotations per minute

const VehicleProperty::Property VehicleProperty::HazardLightStatus = "HazardLightStatus"

static

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

const VehicleProperty::Property VehicleProperty::MachineGunTurretStatus = "MachineGunTurretStatus"

static

Acceleration on the 'x' axis in 1/1000 gravitational acceleration "g-force"

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

static

Various property types:

Vehicle Velocity in km/h

const VehicleProperty::Property VehicleProperty::ParkingBrakeStatus = "ParkingBrakeStatus"

static

< Parking Brake Status status of parking break active (true) or inactive (false)

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

static

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

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

static

< Securty Alert Status status of security alert

See Also: Security::Status

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

static

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

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

static

TODO: Rename to "SteeringWheel" in 0.13.

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::PowerModes

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::VIN = "VIN"

static

< Vehicle Identification Number (ISO 3779) 17 chars

const VehicleProperty::Property VehicleProperty::WasherFluidLevel = "WasherFluidLevel"

static

< Washer Fluid Level 0-100%.

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/tripzero/src/automotive-message-broker/lib/vehicleproperty.h
/home/tripzero/src/automotive-message-broker/lib/vehicleproperty.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Member Typedef Documentation

Member Function Documentation

Member Data Documentation