Eplan Platform API
Inheritance Hierarchy
In This Topic
Eplan.EplApi.EServices Namespace
In This Topic
This namespace contains classes for electrotechnical messages and verifications.
Classes
 ClassDescription
ClassBaseProjectMessage Base class for project messages. It is not stored in database.
ClassElectroMessage base class for a template of a project message
ClassFunctionVerification Base class for specific verification classes that only check functions.
ClassInterruptionPointVerification Basis class for special test classes, which examine only interruption points.
ClassMessage Base class for electrotechnical messages. If an add-in wants to add an undefined project message to EPLAN projects, then the class of the add-in must inherit from the Eplan.EplApi.EServices.Message class.
ClassPartVerification Base class for specific test classes.
ClassPotentialVerification Base class for specific verification classes that only check potentials.
ClassPrjMessagesCollection Collection of project messages of the last check run (See ribbon "Tools>Review>Check" or !!OVERLOADED_VerifyProject_Eplan::EplApi::HEServices: ).
ClassPrjMessagesEnumerator supports a simple iteration over Eplan::EplApi::EServices:
ClassPrjMessagesRegisteredCollection This is a collection of all possible message types, registered in the system, that can be used by PrjMessagesCollection.
ClassPrjMessagesRegisteredEnumerator iterates over all registered electrotechnical messages of the system Eplan::EplApi::EServices:
ClassProjectMessage Base class for project messages.
ClassSubProject Represents subproject specified by the defined working sections.
ClassSubProjectsCollection Represents collection of subprojects specified by the defined working sections that are possible for given project.
ClassVerification Base class for specific test classes.
Interfaces
 InterfaceDescription
InterfaceIFunctionVerification Interface for a special verification class.
InterfaceIInterruptionPointVerification Interface for a special test class.
InterfaceIMessage Interface declaration for an electrotechnical message in EPLAN. If an add-in wants to add an undefined project message to EPLAN projects, then the class of the add-in must inherit from the Eplan.EplApi.EServices.Message class.
InterfaceIPartVerification Interface declaration for a part check in EPLAN. If an add-in wants to add an undefined part check to EPLAN projects this interface must be implemented by a class of the add-in.
InterfaceIPotentialVerification Interface for a special verification class.
InterfaceIVerification Interface declaration for an electrotechnical check in EPLAN. If an add-in wants to add an undefined check to EPLAN projects this interface must be implemented by a class of the add-in.
InterfaceIVerificationBase Base interface declaration for a check in EPLAN. If an add-in wants to add an undefined check to EPLAN projects please implement interface IVerification or IPartVerification.
Structures
 StructureDescription
StructureProjectMessagesListWrapper TODO
Delegates
 DelegateDescription
DelegatePrjMessagesEnumerator.CollectionChangesEventHandler  
Enumerations
 EnumerationDescription
EnumerationIMessage.Classification Pre- defined classifications for project messages; every project message must be assigned to one of these classifications, other values will not be supported. The classification of a project message could be changed in the settings dialog at run time.
EnumerationIMessage.ProjectMessageCreationType Methods by which a project message have been created.
EnumerationIMessage.Region Predefined regions for project messages; every project message must be assigned to one of these regions, other values will not be supported
EnumerationIVerificationBase.Permission The permission of a verification determines for what type of check the verification is enabled at most/ maximum.
EnumerationIVerificationBase.VerificationState The VerificationState determines the actual adjusted check type whereas the permission determines what state is theoretically allowed at most.
EnumerationMessage.MessageStateType Message state types
EnumerationSubProject.SubProjectStatus Possible statuses of subproject.
See Also

Reference

Eplan.EplApi.EServicesu Assembly

 

 

EPLAN API , 17.02.2025, © by EPLAN GmbH & Co. KG. All rights reserved.

Use the Eplan Global Support Portal for feedback and support