 |
BT-MatML-Editor 0.1.4
Editor for the MatML 3.1 XML Schema
|
|
BT-MatML-Editor 0.1.4
Editor for the MatML 3.1 XML Schema
|
Author Paul McGrath Date June, 2022
The MatML Editor is a text Editor for the MatML 3.1 XML Schema.
MatML is an extensible markup language (XML) developed especially for the interchange of material information. It provides a medium of communication for users in materials science and related fields such as manufacturing and aerospace. It sets the stage for the development of semantic web standards to enhance knowledge discovery in materials science and related areas.
Goto Releases and under Assets download the win64 for Microsoft Windows releases and Linux for Linux releases.
To run the program, click on the BT-MatML-Editor application.
Once running click on 'File->Open', or 'File->New', to start.
The general approach to the program is to use the Tree Control user interface to navigate through the MatML data elements. The tree on the left side is the main navigation aid (1). Mouse click on the elements of the tree and then left mouse click to get more options, such as to add more data elements to the Tree Control. The MatML Schema Information will show up on the right panel (2). The tabs for the right panel (3) will display either the MatML Schema Information (default) or the MatML data itself (can be changed in 'Edit->Preferences').
While the BT-MatML-Editor is not a database, and not optimized for extremely large files, it can handle multimaterial files. These larger files are more manageable using the following tools.
Sorting the view of the materials. In 'Edit->Preferences->Sort class', it is possible to add sort classes. This option will changed the view (not the xml file) of the materials. Adding "STEEL" for an example, will display the Materials with the class name of "STEEL" first. Then the remainding materials will be displayed in the order the are in inside the XML file. Once set, 'view->perform material sort' will change the view order of the materials.
One other option for viewing larger files is the use of 'view->Isolate material branch'. This will isolate materials which are interconnected with ' Material -> ComponentDetails -> Class -> ParentMaterial ' associations. To exit this view, 'View->Exit Isolate material branch' will bring back the original list of materials.
Development source code is hosted on GitHub and source code for stable release versions are found at releases along with the binaries.
The following prerequisites dependencies are:
For Building CMake 3.24
To Build:
cmake-gui
Within cmake-gui:
Set the "Where to build the binaries" directory to the BT-MatML-Editor root/build
Within the generator (e.g. Visual Studio):
In a shell with Administrator privileges (so you can install into "C:/Program Files"):
To run:
Package generation:
Package Checksum Values in Windows 10
To build:
To run:
Package generation:
Package Checksum Values in Linux
for doxygen doc see here for active hyperlinks
The program is structure to perform the following tasks:
The XML data binding into C++ is done using CodeSynthesis-XSD data binding compiler. The compiler produces the matml31.hxx, matml31.cxx files. Add these to your project file.
Place the XML Schema Definition file matml31.xsd in the same directory as the xml data (*.xml).
The xerces-c parsing libraries should be linked in your project. For Windows adding xerces-c_3_1.dll and xerces-c_3_1D.dll to the library paths would do it.
With these files above, the user can perform C++ material calculations.
The MatML_Editor is the GUI for the purpose of providing an input, or output, to these C++ material calculations or used on its own as a MatML Editor.
As per the wxWidgets DECLARE_APP and IMPLEMENT_APP macros, class bellshire::BT_MatML_App defines the entry point for the console application.
bellshire::BT_MatML_App::OnInit function calls for the creation of the class bellshire::MaterialFrame, which is the main GUI class for the application.
bellshire::MaterialFrame constructor bellshire::MaterialFrameBase::MaterialFrameBase then calls for the creation of all the different MatML GUI classes via the class bellshire::GUI.
The class bellshire::GUI constructor bellshire::GUI::GUI(wxWindow* parent), calls for the creation of the individual MatML GUIs, such as class bellshire::MatML_Doc_GUI.
The individual MatML GUIs, such as class bellshire::MatML_Doc_GUI_Base constructor bellshire::MatML_Doc_GUI_Base::MatML_Doc_GUI_Base, then create the final GUI for the associated MatML data class, such as MatML_Doc. See the table below for the MatML data and the associated MatML GUI classes.
The base classes, such as bellshire::MaterialFrameBase and the individual MatML GUIs, such as bellshire::MatML_Doc_GUI_Base, contain the creation of the GUIs, virtual Event Handler Functions, and binding the Event Handler Functions.
The derived classes, such as bellshire::MaterialFrame and the individual MatML GUIs, such as bellshire::MatML_Doc_GUI, contain the overwriting of the Event Handler Functions occuring in the base.
It should also be noted that not all instances of MatML data have MatML GUIs associated with them, but all classes of MatML data do. This means that changing MatML data will require showing, and updating, the MatML GUIs to show the new MatML data.
The naming MatML data class and associated MatML GUI classes is as such,
Because the not all instances of MatML data have MatML GUIs associated with them, but all classes of MatML data do, the MatML Editor relies on polymorphic functions to select the appropriate class type to operate on.
The polymorphic functions uses boost::any pointers. The bellshire::TreeCtrlSorted, a derivative of wxTreeCtrl, stores user data in each of its tree elements. Using this functionality the editor stores data such as the bellshire::MatMLTreeItemData which contains the boost::any pointer.
The bellshire::TreeCtrlSorted mimics the tree structure of the MatML_data and allows the user data to be pulled from the tree elements and used.
After the user data is pulled the a given MatML data`s class typeid is compared to the boost::any.type. When the comparison matches, a function is either called, or the data is boost::any_cast back into the MatML data pointer for further processing.
When the MatML data structure is changed the bellshire::TreeCtrlSorted is recreated once again mimicking the MatML data structure.
An example is a function for updating of the MatML GUIs,
void bellshire::GUI::Update_GUI(::boost::any anyptr, ::boost::shared_ptr<MatML_Doc> doc)
this will Update the appropriate GUI depending on the type of MatML data pointer the ::boost::any pointer caste into.
Another, function is a function showing the context menu,
void bellshire::MaterialFrame::ShowContextMenu(wxTreeItemId id, const wxPoint& pt)
it will create a context menu showing possible selections depending on the bellshire::MatMLTreeItemData (has a member of boost::any pointer) selected.
1.9.3