Elipse Plant Manager — EPM Web API

Version 5.0.45

epmwebapi.datasetpen

class DatasetPen:

Class representing a Dataset Pen.

DatasetPen(dataset, title, dataSourceName=None, penConfig=None)
title: str

Returns the title of a Pen.

Returns

Title of a Pen.

dataSource: str

Returns the data source of a Pen.

Returns

A str with a Pen's data source.

isRaw: bool

Returns whether a Pen contains raw data.

Returns

True if a Pen contains raw data or False otherwise.

Returns the Aggregate Type of a Pen.

Returns

An epmwebapi.aggregatedetails.AggregateDetails object with the Aggregate Type of this Pen.

def setTitle(self, title: str):

Sets a title for this Pen.

Parameters
  • title: A title for this Pen.
Raises
  • Exception: Title exceeded maximum allowed size.
  • Exception: Invalid character on the title parameter.
  • Exception: The title parameter must be a str.
def setAggregationType( self, aggregateType: epmwebapi.aggregatedetails.AggregateType, processInterval: datetime.timedelta):

Sets an Aggregate Type for this Pen.

Parameters
Raises
def setRawType(self):

Sets if this Pen's data is raw.

def setDataSource(self, name: str):

Sets this Pen's data source.

Parameters
  • name: Name of a data source for this Pen.