AdHocPythonAggregate

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.history.AdHocPythonAggregate

All Implemented Interfaces:: Aggregate, Serializable

public class AdHocPythonAggregate extends Object implements Aggregate

Defines an aggregation function that is defined in python. This can be either a full definition, or a referenced to a shared library.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type

Field

Description

static final String

SIGNATURE

These are the parameters (the expected signature) of the function

Fields inherited from interface com.inductiveautomation.ignition.common.sqltags.history.Aggregate
AD_HOC_PYTHON_ID, CUSTOM_RESERVED_ID, PYTHON_LIB_ID, SERIALIZATION_WHITELIST
Constructor Summary

Constructors

Constructor

Description

AdHocPythonAggregate()

AdHocPythonAggregate(String function, boolean isLibRef)
Method Summary

Modifier and Type

Method

Description

String

getDesc()

A possible description for how the aggregate behaves.

String

getFunction()

int

getId()

Returns the identifier for the aggregate.

String

getName()

A display name for the aggregate.

boolean

isLibraryReference()

If true, the "function" here is actually a path to a function defined in a shared library, such as "shared.custom.coolaggregate"

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- SIGNATURE
  
  public static final String SIGNATURE
  
  These are the parameters (the expected signature) of the function
  See Also:
  
  Constant Field Values
Constructor Details
- AdHocPythonAggregate
  
  public AdHocPythonAggregate()
- AdHocPythonAggregate
  
  public AdHocPythonAggregate(String function, boolean isLibRef)
Method Details
- getFunction
  
  public String getFunction()
- isLibraryReference
  
  public boolean isLibraryReference()
  
  If true, the "function" here is actually a path to a function defined in a shared library, such as "shared.custom.coolaggregate"
- getId
  
  public int getId()
  
  Description copied from interface: Aggregate
  
  Returns the identifier for the aggregate. This is the only true identifier for the aggregate, name and description should not be taken into account for equality.
  
  Specified by:
  
  getId in interface Aggregate
- getName
  
  public String getName()
  
  Description copied from interface: Aggregate
  
  A display name for the aggregate.
  
  Specified by:
  
  getName in interface Aggregate
- getDesc
  
  public String getDesc()
  
  Description copied from interface: Aggregate
  
  A possible description for how the aggregate behaves.
  
  Specified by:
  
  getDesc in interface Aggregate