Introduction to EON SDK - Construction IT research at VTT

More documents

Recommendations

Info

User Guide Techniques FLEXlm licensing The FLEXlm feature name must be the same as the module identifier in the registry; this is automatically the case with an EON Module Wizard generated module. A module (feature) name must be unique, alphanumerical phrase. If you plan to use a licensing system other than FLEXlm, the same requirements apply. If FLEXlm is used, the IAutApp interface (see the reference guide) may be used to gain access to the license server through EON Studio by using the CheckOutFeature() function, for example. A license or feature always has a version number. It is important to know that the license version number is not the same as the program version number. Changing the license version number will cause all older license keys to expire. The recommended procedure is to keep the same license version number between major EON upgrades. In other words, EON 2.1, 2.2 and 2.5 would all use the same license version number, but when EON 3.0 arrives, the license version number should be incremented. Note: the version number of any feature may not exceed 10 digits (floating point format) due to restrictions in the current version of FLEXlm. EON Studio and modules In order for EON Studio to find a module and its nodes, unique module/node identifiers must be placed in the registry. EON modules are registered as follows (note that the version key, 2.0, is correct, since it indicates which major version EON has reached): HKEY_LOCAL_MACHINE \ SOFTWARE \ Prosolvia Clarus \ Clarus EON \ 2.0 \ Modules \ The entry in the registry shall contain the following information: • The name of the module should be placed as the default value. • Whether the module is loaded or not. “0” means not loaded, “1” means loaded. The registry name is LOADED. • Whether the module is distributable or not. “0” means not distributable, “1” means distributable. Use the registry name DISTRIBUTABLE. To protect against tampering, this information is double-checked against the registry. Nodes that are part of a module register themselves as follows: HKEY_LOCAL_MACHINE \ SOFTWARE \ Prosolvia Clarus \ Clarus EON \ 2.0 \ Modules \ \ \ The entry for the node shall contain: • The CLSID for the node. Use the registry key name CLSID. 14 EON SDK 2.53.0
User Guide Wizards • The name of the DLL containing the icon for the node. Use the registry key name IconDLL. • The resource ID of the Icon. Use the registry key name IconID. Module registration functionality is already implemented in the code skeleton generated by the EON Module Wizard, but if the module contains nodes, macros for their registration must be added to the module skeleton: insert OBJECT_ENTRY(, ) lines between the BEGIN_OBJECT_MAP() and END_OBJECT_MAP() macros in the .cpp file. The macro DECLARE_MODULE_CLSID() will use as its licensing unit and should be inserted in the public area of the node's class declaration. All modules must support the IEonModule interface for—among several other purposes—license protection. EON Studio needs to call the IEonModule functions CheckOutLicense(), OnConnect(), OnDisconnect() and CheckInLicense() during license handling. How to disable licensing on your module If you do not wish to use license protection on your module, always return LICENSE_OK from your CheckOutLicense() function and a non-zero value from your OnConnect() function. The relation between EON Studio and its modules EON Studio consists of several components that interact with one another to provide the user with a working application. These components are often implemented as separate modules that are loaded automatically—and unconditionally—when you start EON Studio (for example, some of those modules are the ones that display the Butterfly, Scene graph and Component views). The EON Studio application follows Windows so called document–view object model that splits the responsibilities between a number of components, namely: • the document, which is the object that encapsulates the actual data (the document corresponds to a complete EON simulation), and • a number of views that present the data in different ways (for example the Routes window or the Simulation Tree window). When the user modifies the application's data, these modifications are directed towards the document. If the data has changed, some of the views might need to be updated. The views only display subsets of all the information contained in a document—the views would otherwise be completely cluttered with facts and figures, and thus they would be more or less worthless to the user. An application could host several documents—that is, several sets of data—but EON Studio currently supports only one document (simulation) at a time. (However, this might change in later versions of EON Studio.) 2.5 15
Page 1 and 2: Introduction to EON SDK Jan 2002 ©
Page 3 and 4: User’s Guide Introduction Introdu
Page 5 and 6: User Guide Installation modules. By
Page 7 and 8: User Guide Wizards enhance function
Page 9 and 10: User Guide Wizards or multiple-valu
Page 11 and 12: User Guide Wizards EON SDK can also
Page 13: User Guide Wizards Although not fea
Page 17 and 18: User Guide Wizards lists based on t
Page 19 and 20: User Guide Wizards Studio are actua
Page 21 and 22: User Guide Wizards 9. Select which
Page 23 and 24: User Guide Wizards Node class defin
Page 25 and 26: User Guide Wizards If you use Direc
Page 27 and 28: User Guide Wizards disable licensin
Page 29 and 30: User Guide Wizards Writing modules
Page 31 and 32: User Guide Techniques when it goes
Page 33 and 34: User Guide Techniques the * and ->
Page 35 and 36: User Guide Techniques ); if (FAILED
Page 37 and 38: Reference Guide Introduction Introd
Page 39 and 40: Reference Guide Classes in EON SDK
Page 41 and 42: Reference Guide Modules Modules Int
Page 43 and 44: Reference Guide Interfaces IAgent U
Page 45 and 46: Reference Guide Interfaces SetDefau
Page 47 and 48: Reference Guide Interfaces GetIdOfN
Page 49 and 50: Reference Guide Interfaces SetStrin
Page 51 and 52: Reference Guide Interfaces GetInsta
Page 53 and 54: Reference Guide Interfaces GetJoyst
Page 55 and 56: Reference Guide Interfaces GetRefer
Page 57 and 58: Reference Guide Interfaces UseLogTy
Page 59 and 60: Reference Guide Interfaces ISimulat
Page 61 and 62: Reference Guide Interfaces Index Ac
Page 63: Reference Guide Interfaces LockRend

Introduction to EON SDK - Construction IT research at VTT

Create successful ePaper yourself

Delete template?

Save as template?