Package com.inductiveautomation.ignition.gateway.tags.actors.factories.scaling

Class ScalingActorFactory

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.actors.factories.scaling.ScalingActorFactory

All Implemented Interfaces:

TagActorFactory

public class ScalingActorFactory
extends Object
implements TagActorFactory

since 8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ScalingActorFactory.ScalingActor

Constructor Summary

Constructors

Constructor	Description
ScalingActorFactory()

Method Summary

Modifier and Type	Method	Description
void	addBrowseTraits(NodeDescription.NodeDescriptionBuilder desc, PropertySet config)	Gives the actor factory a chance to report NodeAttribute traits for the tag it belongs to.
TagActor	create(NodeContext context, PropertySet config)	Creates the actor for the given settings.
ActorClassification	getActorClassification()	Every tag can only have one of each actorTypeId.
Set<Property<?>>	getMonitoredProperties()	These are the properties that this actor monitors for changes.
boolean	isApplicable(PropertySet config)	Indicates that the PropertySet has settings that would result in this actor type being created.
void	shutdown()	Indicates the provider or system is shutting down.
void	startup(GatewayContext gwContext)	Called when the factory is registered, before any actors are created.

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.tags.evaluation.TagActorFactory

configureTagGroupModel, configureTagModel, getBrowseValue, getId, getKeyPropertyValues

Constructor Details

ScalingActorFactory

public ScalingActorFactory()

Method Details

getMonitoredProperties

public Set<Property<?>> getMonitoredProperties()

Description copied from interface: TagActorFactory

These are the properties that this actor monitors for changes. This is used to optimize how factories/actors are managed after edits. Any property that the actor cares about (even system properties) should be represented in the returned Set, otherwise the actor will not be notified of edits.

Specified by:

getMonitoredProperties in interface TagActorFactory

getActorClassification

public ActorClassification getActorClassification()

Description copied from interface: TagActorFactory

Every tag can only have one of each actorTypeId. Note that actorId does not necessarily indicate a certain implementation, but instead a type of actor.

Specified by:

getActorClassification in interface TagActorFactory

startup

public void startup(GatewayContext gwContext)

Description copied from interface: TagActorFactory

Called when the factory is registered, before any actors are created.

Specified by:

startup in interface TagActorFactory

shutdown

public void shutdown()

Description copied from interface: TagActorFactory

Indicates the provider or system is shutting down. All of the tags may have been shut down, but at this point, the factory can stop doing anything.

Specified by:

shutdown in interface TagActorFactory

isApplicable

public boolean isApplicable(PropertySet config)

Description copied from interface: TagActorFactory

Indicates that the PropertySet has settings that would result in this actor type being created.

Specified by:

isApplicable in interface TagActorFactory

addBrowseTraits

public void addBrowseTraits(NodeDescription.NodeDescriptionBuilder desc,
 PropertySet config)

Description copied from interface: TagActorFactory

Gives the actor factory a chance to report NodeAttribute traits for the tag it belongs to. NodeAttributes are registered in the designer in order to modify the display of browse nodes.

Specified by:

addBrowseTraits in interface TagActorFactory

create

public TagActor create(NodeContext context,
 PropertySet config)

Description copied from interface: TagActorFactory

Creates the actor for the given settings. isApplicable() has already been checked to confirm that this operation is valid. The actor should not be activated before it is returned.

Specified by:

create in interface TagActorFactory