Eplan.EplApi.Base Namespace
In This Topic
This namespace exposes base functionality of EPLAN, like a base class for exceptions, and classes to access the EPLAN settings.
Classes
| | Class | Description |
|---|
 | BaseException | Exception class derived from ApplicationException. This is the base class for the exceptions that might occur in the API. |
| Context | The Context classes are used to pass information about the current state of the environment as well as generic parameters to objects that can be registered such as actions, dialogs, etc. |
| ContextParameterBlock | A Parameter block for a context. This parameterblock can have System::Object^ as parameters. This block can be used to add objects to a context and work with this objects p.e. inside an action. |
| Decider | This class implements the standard EPLAN decider dialog. |
| EplAssert | The EplAssert class. When the advaced mode is activated in ELogFileConfigTool, Asserts are written to the epllog.txt Its also possible to activate a debugger break. Set the registry value User / Software / Eplan / Eplan W3 / Assert / BreakOnAssert to true, and the debugger will stop at a failed assert. |
| EplTrace | Trace the output to the EplLog.txt file. This Trace class works in debug and release mode, while the trace listener works only in debug mode. Traces are written when the registry key HKCU / Software / Eplan / Eplan W3 / Trace / \-ModuleName- is found. |
| FileSelectDecisionContext | This class can be used for an standard eplan decider |
| ISOCode | Class for managing language codes (abbreviations). MultiLangString can handle these languages. |
| LanguageList | Class for managing a list of languages. |
| Languages | Class for language information. |
| LockingException | Exception class that signals locking errors in DataModel. |
| MultiLangString | This class can save strings in various languages at the same time. Each string can be added, queried, and deleted individually. |
| ParserParameter | Parameter Class for the usage with UnitParser. Configure the unit and the look of the Parser result. |
| PathMap | This class enables you access to the functions used for processing strings that could contain EPLAN path variables. |
| Progress | This class enables you to access the functions of the progress bar in EPLAN. |
| ProgressFactory | This class can be used for OfflineApplications. With RegisterProgress a progress can be installed in Eplan. UnregisterProgress removes this progress from Eplan again. |
| Range | Range of setting values |
| SchemeSetting | Class for editing settings that are grouped into schemes |
| SettingNode | Allows access to settings and relative access to setting-nodes. A setting key consists of a number of sections separated by '.' Each section except the last one is called a setting-node. Setting-nodes and settings together build the settings tree. The settings are the leaves of this tree. The SettingNode class helps iterating trough the nodes and e.g. gives you the possibility to delete a node completely. |
| Settings | Settings are used to save values of variables beyond the runtime of the program and to make them available again the next time program is run (similar to the Windows registry). A setting has a unique identifier in the system. A value or a list of values can be saved to a setting. It is possible to group settings into structures SchemeSetting. |
| SysMessagesCollection | Class that represents the system-wide message tree. The collection contains the system messages as BaseException objects. |
| SysMessagesEnumerator | supports a simple iteration over SysMessagesCollection |
| TraceListener | Output of trace messages to the EPLAN system message management (incl. EPLAN log file) |
| UnitParser | The UnitParser class. Here it is possible to read the unit from a string and convert it in other units (of the same unit group) |
Interfaces
| | Interface | Description |
|---|
 | IContext | IContext is an abstract interface for Context classes. |
| IEplProgress | Interface declaration for a progress. When a progress is to be registered for an add-in (an assembly) in the system, this interface must be implemented by a class of the add-in. |
| ISettings | The common interface to P8 settings. |
Structures
| | Structure | Description |
|---|
 | PointD | This class represents a set of coordinates in EPLAN. |
| PointD3D | This class represents a set of 3D coordinates in EPLAN. |
| RectangleD | This class specifies an area in a coordinate space. |
Enumerations
See Also
