\Generators

Electrical generators management and accounting

Synopsis

class Generators {

• // constants
• const TABLE_DEVICES = 'gen_devices';
• const TABLE_SERVICE_TYPES = 'gen_service_types';
• const TABLE_SERVICES = 'gen_services';
• const TABLE_EVENTS = 'gen_events';
• const TABLE_REFUELS = 'gen_refuels';
• const URL_ME = '?module=generators';
• const ROUTE_DEVICES = 'devices';
• const ROUTE_DELETE_DEVICE = 'deletedeviceid';
• const ROUTE_START_DEVICE = 'startdeviceid';
• const ROUTE_STOP_DEVICE = 'stopdeviceid';
• const ROUTE_VIEW_EVENTS = 'viewevents';
• const ROUTE_VIEW_EVENTS_ALL = 'eventsall';
• const ROUTE_VIEW_SERVICES_ALL = 'servicesall';
• const ROUTE_EDIT_SERVICE = 'editserviceid';
• const ROUTE_VIEW_REFUELS_ALL = 'refuelsall';
• const ROUTE_EDIT_REFUEL = 'editrefuelid';
• const ROUTE_VIEW_MAP = 'rendermap';
• const PROUTE_NEW_DEVICE = 'createdevice';
• const PROUTE_EDIT_DEVICE = 'editdeviceid';
• const PROUTE_DEV_MODEL = 'devmodel';
• const PROUTE_DEV_FUEL_TYPE = 'devfueltype';
• const PROUTE_DEV_TANK_VOLUME = 'devtankvolume';
• const PROUTE_DEV_FUEL_CONSUMPTION = 'devfuelconsumption';
• const PROUTE_DEV_ADDRESS = 'devaddress';
• const PROUTE_DEV_GEO = 'devgeo';
• const PROUTE_DEV_MOTO_HOURS = 'devmotohours';
• const PROUTE_DEV_SERVICE_INTERVAL = 'devserviceinterval';
• const PROUTE_DEV_OP_ALIAS = 'devopalias';
• const PROUTE_REFUEL_DEVICE = 'refueldevice';
• const PROUTE_REFUEL_LITERS = 'refuelliters';
• const PROUTE_REFUEL_PRICE = 'refuelprice';
• const PROUTE_EDIT_REFUEL = 'editrefuel';
• const PROUTE_SERVICE_DEVICE = 'servicedevice';
• const PROUTE_SERVICE_MOTO_HOURS = 'servicemotohours';
• const PROUTE_SERVICE_NOTES = 'servicenotes';
• const PROUTE_SERVICE_DATE = 'servicedate';
• const PROUTE_SERVICE_TIME = 'servicetime';
• const PROUTE_EDIT_SERVICE = 'editservice';
• const WATCHER_PID = 'GENERATORS';
• const OP_MON_MARK = '$generatorState';
• // members
• protected array $altCfg = ;
• protected  $messages = '';
• protected  $devicesDb = '';
• protected  $servicesDb = '';
• protected  $eventsDb = '';
• protected  $refuelsDb = '';
• protected  $onePunch = '';
• protected array $fuelTypes = ;
• protected array $allDevices = ;
• protected array $allServices = ;
• protected array $allEvents = ;
• protected array $allRefuels = ;
• protected array $availScripts = ;
• // methods
• public void __construct()
• protected void loadConfig()
• protected void initMessages()
• protected void initOnePunch()
• protected void loadOnePunchScripts()
• protected void initDb()
• protected void setFuelTypes()
• protected void loadDevices()
• protected void loadServices()
• protected void loadEvents()
• protected void loadRefuels()
• protected int getDeviceEventsCount()
• protected string getNextMaintenanceDate()
• public string createService()
• public float calculateFuelConsumption()
• protected int getDeviceRunningTime()
• public string renderControls()
• protected string renderDeviceStartStopDialog()
• public string renderDevicesList()
• protected string renderServiceForm()
• protected string renderRefuelForm()
• protected float getLatestRefuelPrice()
• public string createRefuel()
• protected void setDeviceIntank()
• public string renderDeviceCreateForm()
• public void createDevice()
• public string deleteDevice()
• public string renderDeviceEditForm()
• public string updateDevice()
• public string startDevice()
• protected int updateDeviceMotohours()
• protected int updateDeviceIntank()
• public string stopDevice()
• public array getDeviceInfo()
• public string renderDeviceEvents()
• public string renderAllServices()
• protected string renderServiceEditForm()
• public string updateService()
• public void runGeneratorsWatcher()
• public string renderAllRefuels()
• protected string renderRefuelEditForm()
• public string updateRefuel()
• public string renderDevicesMap()
• public float calculateInTankPercent()
• public float calculateInTankLevel()
• public array getAllDevices()
• public array getAllDevicesFuelPercent()
• public array getAllDevicesFuelLevel()
}


Constants

Name	Value
TABLE_DEVICES	'gen_devices'
TABLE_SERVICE_TYPES	'gen_service_types'
TABLE_SERVICES	'gen_services'
TABLE_EVENTS	'gen_events'
TABLE_REFUELS	'gen_refuels'
URL_ME	'?module=generators'
ROUTE_DEVICES	'devices'
ROUTE_DELETE_DEVICE	'deletedeviceid'
ROUTE_START_DEVICE	'startdeviceid'
ROUTE_STOP_DEVICE	'stopdeviceid'
ROUTE_VIEW_EVENTS	'viewevents'
ROUTE_VIEW_EVENTS_ALL	'eventsall'
ROUTE_VIEW_SERVICES_ALL	'servicesall'
ROUTE_EDIT_SERVICE	'editserviceid'
ROUTE_VIEW_REFUELS_ALL	'refuelsall'
ROUTE_EDIT_REFUEL	'editrefuelid'
ROUTE_VIEW_MAP	'rendermap'
PROUTE_NEW_DEVICE	'createdevice'
PROUTE_EDIT_DEVICE	'editdeviceid'
PROUTE_DEV_MODEL	'devmodel'
PROUTE_DEV_FUEL_TYPE	'devfueltype'
PROUTE_DEV_TANK_VOLUME	'devtankvolume'
PROUTE_DEV_FUEL_CONSUMPTION	'devfuelconsumption'
PROUTE_DEV_ADDRESS	'devaddress'
PROUTE_DEV_GEO	'devgeo'
PROUTE_DEV_MOTO_HOURS	'devmotohours'
PROUTE_DEV_SERVICE_INTERVAL	'devserviceinterval'
PROUTE_DEV_OP_ALIAS	'devopalias'
PROUTE_REFUEL_DEVICE	'refueldevice'
PROUTE_REFUEL_LITERS	'refuelliters'
PROUTE_REFUEL_PRICE	'refuelprice'
PROUTE_EDIT_REFUEL	'editrefuel'
PROUTE_SERVICE_DEVICE	'servicedevice'
PROUTE_SERVICE_MOTO_HOURS	'servicemotohours'
PROUTE_SERVICE_NOTES	'servicenotes'
PROUTE_SERVICE_DATE	'servicedate'
PROUTE_SERVICE_TIME	'servicetime'
PROUTE_EDIT_SERVICE	'editservice'
WATCHER_PID	'GENERATORS'
OP_MON_MARK	'$generatorState'

Members

protected

• $allDevices — array
  Contains all generator devices as id=>data
• $allEvents — array
  Contains all generator events
• $allRefuels — array
  Contains all generator refuels
• $allServices — array
  Contains all generator services
• $altCfg — array
  Contains system alter.ini config as key=>value
• $availScripts — array
  Contains filtered OnePunch punch scripts for generators state monitoring as alias=>name
• $devicesDb —
  Contains devices database abstraction layer
• $eventsDb —
  Contains events database abstraction layer
• $fuelTypes — array
  Contains available fuel types
• $messages —
  System message helper object placeholder
• $onePunch —
  OnePunch object placeholder
• $refuelsDb —
  Contains refuels database abstraction layer
• $servicesDb —
  Contains services database abstraction layer

Methods

protected

• getDeviceEventsCount() — Gets events count for device
• getDeviceRunningTime() — Gets running time for device since last start event in seconds
• getLatestRefuelPrice() — Gets latest refuel price for device
• getNextMaintenanceDate() — Gets next maintenance date in motohours remaining
• initDb() — Initializes database abstraction layers
• initMessages() — Initializes message helper instance
• initOnePunch() — Initializes onepunch object
• loadConfig() — Loads system alter.ini config
• loadDevices() — Loads all generator devices from database
• loadEvents() — Loads all events from database
• loadOnePunchScripts() — Preloads all one punch scripts and filters them for generators state monitoring
• loadRefuels() — Loads all refuels from database
• loadServices() — Loads all services from database
• renderDeviceStartStopDialog() — Renders device start stop dialog
• renderRefuelEditForm() — Renders refuel edit form
• renderRefuelForm() — Renders refuel form for device
• renderServiceEditForm() — Renders service edit form
• renderServiceForm() — Renders service form for device
• setDeviceIntank() — Sets device intank value
• setFuelTypes() — Sets available fuel types
• updateDeviceIntank() — Updates device fuel lefts counter
• updateDeviceMotohours() — Updates device motohours based on last start event

public

• __construct() — Creates new Generators instance
• calculateFuelConsumption() — Calculates fuel consumption for device during working time
• calculateInTankLevel() — Calculates in tank level for device (in liters)
• calculateInTankPercent() — Calculates in tank percent for device (in percent)
• createDevice() — Creates new generator device
• createRefuel() — Creates refuel record and updates device intank
• createService() — Creates service record for device
• deleteDevice() — Deletes generator device
• getAllDevices() — Returns all devices as id=>deviceData
• getAllDevicesFuelLevel() — Returns all devices fuel levels as id=>fuelLevel (in liters)
• getAllDevicesFuelPercent() — Returns all devices fuel levels as id=>fuelLevel (in percent)
• getDeviceInfo() — Gets device info by ID
• renderAllRefuels() — Renders all refuels report for all devices
• renderAllServices() — Renders all maintenances report for all devices
• renderControls() — Renders navigation controls
• renderDeviceCreateForm() — Renders device creation form
• renderDeviceEditForm() — Renders device edit form
• renderDeviceEvents() — Renders device events like start or stop
• renderDevicesList() — Renders generator devices list with actions
• renderDevicesMap() — Renders devices map
• runGeneratorsWatcher() — Runs generators watcher scripts for all devices
• startDevice() — Starts generator device
• stopDevice() — Stops generator device
• updateDevice() — Updates generator device data
• updateRefuel() — Updates refuel record
• updateService() — Updates service record