Ceetron Result Calculator Framework
|
Copyright © 2019 by Ceetron AS
Ceetron Result Calculator Framework is a framework for writing Result Calculators that can be plugged into applications based on Ceetron 3D Components (CDC). This includes Ceetron Analyzer Desktop and the RemoteModel server (CeeCloudServer) in Ceetron Cloud Components (C3). The same plugin can be used both in cloud and desktop.
The Result Calculator Framework enables the user to create a new Scalar, Vector, Displacement or Tensor (Strain or Stress) result based on already existing results. Note: Using other Remote Calculators as input to a new Remote Calculator is currently not supported!
To compile the framework, example plugins and example apps, we recommend using CMake. Download CMake.
To build and run the examples, please follow the steps below:
> cd Build
> cmake ../ResultCalculator
On Linux/mac, build the solution with:
> make
On Windows, open the project file and build with the selected compiler (e.g. Visual Studio).
The build step will build:
To run the test driver:
```bash cd ExampleApps/TestDriver/ ./TestDriver ../../ExamplePlugins/MinimalPlugin/crc_MinimalPlugin ``` Note: The binaries may be stored in a sub Debug or Release folder on some platforms
There are three steps to creating a ResultCalculatorPlugin
The main file defines the plugin. You define a version and a method for creating the Factory. The initializeResultCalculatorPlugin
method is called by the host to initialize the calculator.
Example: MinimalPlugin.cpp
The factory is responsible for instantiation and deletion of the ResultCalculator and providing information about the calculator. To create the factory, derive from CRCResultCalculatorFactory
and implement the pure virtual methods.
Example: MinimalCalculatorFactory.h/cpp
The calculator is where the meta data (input results, name etc) are communicated to the host and where the actual result calculation occur. To create a calculator, derive from CRCResultCalculator and implement the pure virtual methods.
Example: MinimalCalculator.h/cpp
The Result Calculator can be used with the RemoteModel server (CeeCloudServer). To load your Result Calculator, set the C3_UG_RESULT_CALCULATOR_FOLDER
environment variable to point to the folder with your Result Calculator(s). The CeeCloudServer will load all the Result Calculators in the specified folder. The Result Calculators needs to comply to the following naming scheme:
crc_{PROVIDER_NAME}.[dll|so|dylib]
Example:
crc_MyResultCalculator.dll (Windows), crc_MyResultCalculator.so (Linux)
The server will list the registered Result Calculator when a file is opened. Note: A given Result Calculator may be ignored when loading a model if it's considered to be invalid, e.g. the requested input results don't exist or have mismatching result types and such.
To use your Result Calculator with Ceetron Analyzer Desktop, define the environment variable CEE_RESULT_CALCULATORS_FOLDER
to point to the folder where your Result Calculator is located. Ceetron Analyzer will load all Result Calculator in the specified folder. The Result Calculator file needs to follow the same naming scheme as described above.
Ceetron Result Calculator Framework supports most compilers on most platforms. It has been tested on:
First public release of Ceetron Result Calculator Framework
By using this software, you agree to the Terms & Conditions for use of Ceetron Software as described in https://ceetron.com/licenses/developer-terms-and-conditions.
Ceetron AS, Innherredsveien 7, N-7014 Trondheim, NORWAY
URL: www.ceetron.com
Support: support@ceetron.com
All Rights Reserved. No part of this documentation or the accompanying source code shall be reproduced, stored in a retrieval system or transmitted by any means without written permission from the publisher.