com.inductiveautomation.gateway.tags.history.module

Class TagHistorianGatewayHook

java.lang.Object

com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

com.inductiveautomation.gateway.tags.history.module.TagHistorianGatewayHook

All Implemented Interfaces:

GatewayModuleHook

public class TagHistorianGatewayHook
extends AbstractGatewayModuleHook

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TagHistorianGatewayHook.DSListener This class watches datasources, and then updates tag historian records accordingly.

Field Summary

Fields

Modifier and Type	Field and Description
static long	EDGE_POINT_LIMIT
static long	EDGE_RECID
static long	EDGE_TIME_LIMIT_MS

Constructor Summary

Constructors

Constructor and Description
TagHistorianGatewayHook()

Method Summary

Modifier and Type	Method and Description
java.util.List<ConfigCategory>	getConfigCategories() A list (may be null or empty) of custom config categories needed by any panels returned by GatewayModuleHook.getConfigPanels()
java.util.List<? extends IConfigTab>	getConfigPanels() A list (may be null or empty) of panels to display in the config section.
static boolean	isEdge() Deprecated. Remove this in Ignition 8 and just use PlatformEdition.isEdge()
boolean	isEnterprise() Deprecated. Remove this in Ignition 8 and just use EdgePlugin.ENTERPRISE.isAvailable()
protected void	register(AggregationMode mode, AggregationFunction func)
protected void	registerAggregationFunctions()
protected void	registerType(TagHistoryProviderType type)
void	setup(GatewayContext context) Called to before startup.
void	shutdown() Called to shutdown this module.
void	startup(LicenseState activationState) Called to initialize the module.

Methods inherited from class com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

configureDeserializer, configureFunctionFactory, configureSerializer, getHomepagePanels, getRPCHandler, getStatusPanels, initializeScriptManager, notifyLicenseStateChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.GatewayModuleHook

getConfigOverviewContributor, getMountedResourceFolder, getMountPathAlias, getStatusOverviewContributor, isFreeModule, mountRouteHandlers, updateSystemMap

Field Detail

EDGE_RECID

public static final long EDGE_RECID

See Also:

Constant Field Values

EDGE_POINT_LIMIT

public static final long EDGE_POINT_LIMIT

See Also:

Constant Field Values

EDGE_TIME_LIMIT_MS

public static final long EDGE_TIME_LIMIT_MS

See Also:

Constant Field Values

Constructor Detail

TagHistorianGatewayHook

public TagHistorianGatewayHook()

Method Detail

setup

public void setup(GatewayContext context)

Description copied from interface: GatewayModuleHook

Called to before startup. This is the chance for the module to add its extension points and update persistent records and schemas. None of the managers will be started up at this point, but the extension point managers will accept extension point types.

registerType

protected void registerType(TagHistoryProviderType type)
                     throws java.lang.Exception

Throws:

java.lang.Exception

startup

public void startup(LicenseState activationState)

Description copied from interface: GatewayModuleHook

Called to initialize the module. Will only be called once. Persistence interface is available, but only in read-only mode.

shutdown

public void shutdown()

Description copied from interface: GatewayModuleHook

Called to shutdown this module. Note that this instance will never be started back up - a new one will be created if a restart is desired

register

protected void register(AggregationMode mode,
                        AggregationFunction func)

registerAggregationFunctions

protected void registerAggregationFunctions()

getConfigCategories

public java.util.List<ConfigCategory> getConfigCategories()

Description copied from interface: GatewayModuleHook

A list (may be null or empty) of custom config categories needed by any panels returned by GatewayModuleHook.getConfigPanels()

getConfigPanels

public java.util.List<? extends IConfigTab> getConfigPanels()

Description copied from interface: GatewayModuleHook

A list (may be null or empty) of panels to display in the config section. Note that any config panels that are part of a category that doesn't exist already or isn't included in GatewayModuleHook.getConfigCategories() will not be shown.

isEdge

@Deprecated
public static boolean isEdge()

Deprecated. Remove this in Ignition 8 and just use PlatformEdition.isEdge()

Use reflection on PlatformEdition to determine if the Gateway is an Edge gateway. Returns false if the PlatformEdition enum doesn't even exist in the current Gateway.

isEnterprise

@Deprecated
public boolean isEnterprise()

Deprecated. Remove this in Ignition 8 and just use EdgePlugin.ENTERPRISE.isAvailable()

Use reflection on EdgePlugin to determine if the Gateway is an Enterprise gateway. Returns false if the EdgePlugin enum doesn't even exist in the current Gateway.