Elipse Plant Manager — EPM Web API

Version 5.0.45

epmwebapi.customtypedefinition

class SimpleProperty:

SimpleProperty(name, initialValue=None)

name

initialValue

class ObjectProperty:

ObjectProperty(name, customType)

name

customType

class AliasProperty:

AliasProperty(name, source)

name

source

class CustomTypeDefinition:

A Class representing a custom type configuration.

CustomTypeDefinition( epmConnection, name: str, icon: str = None, aliasProperties: List = None, simpleProperties: List = None, objectProperties: List = None, placeHolderTypes: List = None)

name: str

Returns

The name of this Custom Type.

icon: str

Returns

A str representing the Base64 UTF-8 encoding of an image.

aliasProperties: List[str]

Returns

A list of Alias properties of this Custom Type.

simpleProperties: List[SimpleProperty]

Returns

A list of Simple Properties of this Custom Type, containing name and initial value.

objectProperties: List[ObjectProperty]

Returns

A list of Object Properties of this Custom Type, containing name and type.

placeHolderTypes: List[str]

Returns

A list of placeholders of this Custom Type, containing the type name.

defaultIcon: str

Returns

A str with the default Base64 UTF-8 encoding of an image.

def updateIcon(self, pathName: str):

Changes the icon for this Custom Type.

Parameters

pathName: A path to a new image file.

def removeIcon(self):

Resets the icon for this Custom Type.

def addAliasProperty(self, aliasName: str):

Adds a new AliasProperty to this Custom Type.

Parameters

aliasName: Name of a new AliasProperty.

Raises

Exception: Name already exists.

def removeAliasProperty(self, aliasName: str):

Removes an AliasProperty from this Custom Type.

Parameters

aliasName: Name of an AliasProperty to remove.

Raises

Exception: AliasProperty not found.

def addSimpleProperty(self, name: str, initialValue: object = None):

Adds a new SimpleProperty to this Custom Type.

Parameters

name: Name of a new SimpleProperty.
initialValue: Optional parameter indicating an initial value for this SimpleProperty. Default is None.

Raises

Exception: Name already exists.

def removeSimpleProperty(self, name: str):

Removes a SimpleProperty from this Custom Type.

Parameters

name: Name of a SimpleProperty to remove.

Raises

Exception: SimpleProperty not found.

def addObjectProperty(self, name: str, customType: str):

Adds a new ObjectProperty to this Custom Type.

Parameters

name: Name of a new ObjectProperty.
customType: Type of this new ObjectProperty.

Raises

Exception: ObjectProperty does not exist.
Exception: Name already exists.

def removeObjectProperty(self, name: str):

Removes an ObjectProperty from this Custom Type.

Parameters

name: Name of an ObjectProperty to remove.

Raises

Exception: ObjectProperty not found.

def addPlaceHolderType(self, customTypeName: str):

Adds a new placeholder to this Custom Type.

Parameters

customTypeName: Type of a placeholder.

Raises

Exception: Type already is a placeholder.
Exception: Type of placeholder does not exist.

def removePlaceHolderType(self, customTypeName: str):

Removes a placeholder from this Custom Type.

Parameters

customTypeName: Name of a placeholder to remove.

Raises

Exception: Placeholder not found.

def save(self):

Saves the current configuration of this Custom Type.

def delete(self):

Deletes this Custom Type.

def exportJSON(self, fileName: str = None, pathName: str = None) -> dict:

Exports this Custom Type configuration to a file in JSON format.

Parameters

fileName: Optional parameter with the name of a configuration file. Default is None.
pathName: Optional parameter with a path to save the configuration file. Default is None.