Elipse Plant Manager — EPM Web API

Version 5.0.45

epmwebapi.epmdataobject

class EpmDataObjectPropertyNames(enum.Enum):

Enumeration with all types of properties of EPM Data Objects.

Name = <EpmDataObjectPropertyNames.Name: '4:Name'>
Description = <EpmDataObjectPropertyNames.Description: '4:Description'>
EU = <EpmDataObjectPropertyNames.EU: '0:EngineeringUnits'>
LowLimit = <EpmDataObjectPropertyNames.LowLimit: '4:RangeLow'>
HighLimit = <EpmDataObjectPropertyNames.HighLimit: '4:RangeHigh'>
Clamping = <EpmDataObjectPropertyNames.Clamping: '4:RangeClamping'>
Domain = <EpmDataObjectPropertyNames.Domain: '4:Discrete'>
Annotations = <EpmDataObjectPropertyNames.Annotations: '4:Annotations'>
Inherited Members
enum.Enum
name
value
class EpmDataObjectAttributeIds(enum.Enum):

Enumeration with all types of attribute IDs of EPM Data Objects.

Inherited Members
enum.Enum
name
value
class ClampingMode(enum.Enum):

Enumeration with all types of clamping modes.

NoneClamping = <ClampingMode.NoneClamping: 0>
Discard = <ClampingMode.Discard: 1>
ClampToRange = <ClampingMode.ClampToRange: 2>
Inherited Members
enum.Enum
name
value
def getDiscreteValue(domain):
def getDomainValue(discrete):
class EpmDataObject(epmwebapi.epmvariable.EpmVariable):

Class representing a DataObject

EpmDataObject(epmConnection, name, itemPath)
description: str

Returns or sets the description of a Data Object.

Parameters
  • value: A description for this Data Object.
Returns

The description of a Data Object.

eu: str

Returns or sets the engineering unit of a Data Object.

Parameters
  • value: An engineering unit for this Data Object.
Returns

The engineering unit of a Data Object.

lowLimit: float

Returns or sets the clamping low limit of a Data Object.

Parameters
  • value: A new clamping low limit for this Data Object.
Returns

The clamping low limit of a Data Object.

highLimit: float

Returns or sets the clamping high limit of a Data Object.

Parameters
  • value: A new clamping high limit for this Data Object.
Returns

The clamping high limit of a Data Object.

clamping: str

Returns or sets the clamping type of a Data Object.

Parameters
  • value: Clamping type for this Data Object. Possible values are ClampToRange, Discard, or None.
Returns

The current clamping type of this Data Object.

domain: str

Returns or sets the domain of a Data Object.

Parameters
  • value: Domain for this Data Object. Possible values are Continuous, Discrete or None.
Returns

The domain of this Data Object.

active: bool
Returns

True if a Data Object is active or False if it is not.

def readAnnotations( self, start: datetime.datetime, end: datetime.datetime) -> List[Tuple[datetime.datetime, str, str]]:

Returns a list of Annotations registered for the informed period.

Parameters
  • start: Starting period.
  • end: Ending period.
Returns

A list with all Annotations found.

def deleteAnnotations( self, start: datetime.datetime, end: datetime.datetime, allUsers: bool = False):

Removes Annotations from the informed period.

Parameters
  • start: Starting period.
  • end: Ending period.
  • allUsers: A bool indicating whether to delete Annotations from all users or not. Default is False.
def writeAnnotation( self, timestamp: datetime.datetime, message: str, override: bool = True):

Writes an Annotation.

Parameters
  • timestamp: Timestamp of the Annotation to write.
  • message: Message of the Annotation to write.
  • override: A bool indicating whether this message must override an existing Annotation or not. Default is True.
def readAttributes(self):

Reads all attributes of a Data Object.

def enumProperties(self) -> OrderedDict[str, epmwebapi.epmproperty.EpmProperty]:
Returns

An Ordered Dictionary with all properties of a Data Object.

Inherited Members
epmwebapi.epmvariable.EpmVariable
name
path
recordedValue
historyReadRaw
read
write
historyReadAggregate
historyUpdate
historyDelete
Copyright © 2017–2024 Elipse Software Ltda. All rights reserved. Distributed under MIT License.