import Event from 'opengate-js/src/collection/devices/collect/Event.js'

public class | source

Event

Direct Subclass:

DeviceMessage

This is a base object that allows the user to create a Event.

Constructor Summary

Public Constructor
public	constructor(ogapi: *)

Method Summary

Public Methods
public	composeElement(): *
public	withCommsModule(communicationsModules: *): Event Set the powerSupply attribute
public	withCpuUsage(cpuUsage: *): Event Set the cpuUsage attribute
public	withCurrentTemperature(currentTemperature: string): Event Set the currentTemperature attribute
public	withDateLocation(date: string): Event Set the date attribute
public	withDeviceId(deviceId: string): Event Set the deviceId attribute
public	withEventDescription(description: string): Event Set the description attribute
public	withEventId(id: string): Event Set the id attribute
public	withEventName(name: string): Event Set the name attribute
public	withHardware(hardware: Hardware): Event Set the hardware attribute
public	withLatitude(latitude: number): Event Set the latitude attribute
public	withLongitude(longitude: number): Event Set the longitude attribute
public	withMaximumTemperature(maximumTemperature: string): Event Set the maximum attribute
public	withMinimumTemperature(minimumTemperature: string): Event Set the minimum attribute
public	withNonVolatilStorage(nonVolatilStorage: *): Event Set the nonVolatilStorage attribute
public	withOperationalStatus(operationalStatus: string): Event Set the operationalStatus attribute
public	withPath(path: string): Event Set the path attribute
public	withPowerSupply(powerSupply: *): Event Set the powerSupply attribute
public	withRam(ram: *): Event Set the Ram attribute
public	withSoftware(software: software): Event Set the software attribute
public	withStatusTemperature(unitTemperature: string): Event Set the unitTemperature attribute
public	withTemperatureAverage(averageTemperature: string): Event Set the average attribute
public	withTrendTemperature(unitTemperature: string): Event Set the unitTemperature attribute
public	withUnitTemperature(unitTemperature: string): Event Set the unitTemperature attribute
public	withUpTime(upTime: number): Event Set the upTime attribute
public	withVolatilStorage(volatilStorage: *): Event Set the volatilStorage attribute

Public Constructors

public constructor(ogapi: *) source

Params:

Name	Type	Attribute	Description
ogapi	*

Public Methods

public composeElement(): * source

Return:

public withCommsModule(communicationsModules: *): Event source

Set the powerSupply attribute

Params:

Name	Type	Attribute	Description
communicationsModules	*

Return:

Event

public withCpuUsage(cpuUsage: *): Event source

Set the cpuUsage attribute

Params:

Name	Type	Attribute	Description
cpuUsage	*

Return:

Event

public withCurrentTemperature(currentTemperature: string): Event source

Set the currentTemperature attribute

Params:

Name	Type	Attribute	Description
currentTemperature	string		optionals field

Return:

Event

public withDateLocation(date: string): Event source

Set the date attribute

Params:

Name	Type	Attribute	Description
date	string		optionals field

Return:

Event

public withDeviceId(deviceId: string): Event source

Set the deviceId attribute

Params:

Name	Type	Attribute	Description
deviceId	string		optionals field

Return:

Event

public withEventDescription(description: string): Event source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string		optionals field

Return:

Event

public withEventId(id: string): Event source

Set the id attribute

Params:

Name	Type	Attribute	Description
id	string		optionals field

Return:

Event

public withEventName(name: string): Event source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		optionals field

Return:

Event

public withHardware(hardware: Hardware): Event source

Set the hardware attribute

Params:

Name	Type	Attribute	Description
hardware	Hardware		optionals field

Return:

Event

public withLatitude(latitude: number): Event source

Set the latitude attribute

Params:

Name	Type	Attribute	Description
latitude	number		optionals field

Return:

Event

public withLongitude(longitude: number): Event source

Set the longitude attribute

Params:

Name	Type	Attribute	Description
longitude	number		optionals field

Return:

Event

public withMaximumTemperature(maximumTemperature: string): Event source

Set the maximum attribute

Params:

Name	Type	Attribute	Description
maximumTemperature	string		optionals field

Return:

Event

public withMinimumTemperature(minimumTemperature: string): Event source

Set the minimum attribute

Params:

Name	Type	Attribute	Description
minimumTemperature	string		optionals field

Return:

Event

public withNonVolatilStorage(nonVolatilStorage: *): Event source

Set the nonVolatilStorage attribute

Params:

Name	Type	Attribute	Description
nonVolatilStorage	*

Return:

Event

public withOperationalStatus(operationalStatus: string): Event source

Set the operationalStatus attribute

Params:

Name	Type	Attribute	Description
operationalStatus	string

Return:

Event

public withPath(path: string): Event source

Set the path attribute

Params:

Name	Type	Attribute	Description
path	string		optionals field

Return:

Event

public withPowerSupply(powerSupply: *): Event source

Set the powerSupply attribute

Params:

Name	Type	Attribute	Description
powerSupply	*

Return:

Event

public withRam(ram: *): Event source

Set the Ram attribute

Params:

Name	Type	Attribute	Description
ram	*

Return:

Event

public withSoftware(software: software): Event source

Set the software attribute

Params:

Name	Type	Attribute	Description
software	software		optionals field

Return:

Event

public withStatusTemperature(unitTemperature: string): Event source

Set the unitTemperature attribute

Params:

Name	Type	Attribute	Description
unitTemperature	string		optionals field

Return:

Event

public withTemperatureAverage(averageTemperature: string): Event source

Set the average attribute

Params:

Name	Type	Attribute	Description
averageTemperature	string		optionals field

Return:

Event

public withTrendTemperature(unitTemperature: string): Event source

Set the unitTemperature attribute

Params:

Name	Type	Attribute	Description
unitTemperature	string		optionals field

Return:

Event

public withUnitTemperature(unitTemperature: string): Event source

Set the unitTemperature attribute

Params:

Name	Type	Attribute	Description
unitTemperature	string		optionals field

Return:

Event

public withUpTime(upTime: number): Event source

Set the upTime attribute

Params:

Name	Type	Attribute	Description
upTime	number

Return:

Event

public withVolatilStorage(volatilStorage: *): Event source

Set the volatilStorage attribute

Params:

Name	Type	Attribute	Description
volatilStorage	*

Return:

Event