File size: 4,175 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | /***************************************************************************
* Copyright (c) 2013 Jürgen Riegel <FreeCAD@juergen-riegel.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef Fem_FemAnalysis_H
#define Fem_FemAnalysis_H
#include <App/DocumentObjectGroup.h>
#include <App/FeaturePython.h>
#include <App/PropertyStandard.h>
#include <Mod/Fem/FemGlobal.h>
namespace Fem
{
/**
* @brief Container of objects relevant to one simulation.
*
* @details
* A Analysis contains all objects necessary for a complete specification
* of a simulation. After computing it also contains the result of the
* simulation. The Analysis object is just a container. It is not responsible
* for anything else like executing the simulation.
*
* The Analysis class is essentially a App::DocumentObjectGroup. It handles
* all the container stuff. The difference is that the Analysis document
* object uses a different ViewProvider, has a Uid property and does some
* compatibility handling via handleChangedPropertyName.
*
* This implies that it is not checked which objects are put into the
* Analysis object. Every document object of FreeCAD can be part of a
* Analysis.
*/
class FemExport FemAnalysis: public App::DocumentObjectGroup
{
PROPERTY_HEADER_WITH_OVERRIDE(Fem::FemAnalysis);
public:
/**
* Uses Base::Uuid to initialize the Uid property to a newly generated
* unique id because PropertyUUID doesn't initialize itself.
*/
FemAnalysis();
~FemAnalysis() override;
/**
* A unique identifier for each Analysis object. Useful when doing
* filesystem operations because it can provide a unique file or
* directory name for an analysis. Retains its value across save/load
* cycles.
*/
App::PropertyUUID Uid;
const char* getViewProviderName() const override
{
return "FemGui::ViewProviderFemAnalysis";
}
protected:
/**
* @brief Retain compatibility with old "Member" property.
*
* @details
* In an older version of FreeCAD FemAnalysis handles it's member itself
* in a property called "Member". Now this is handled in the "Group"
* property of DocumentObjectGroup. This methods translates old files
* still using the "Member" property.
*/
void handleChangedPropertyName(
Base::XMLReader& reader,
const char* TypeName,
const char* PropName
) override;
};
class FemExport DocumentObject: public App::DocumentObject
{
PROPERTY_HEADER_WITH_OVERRIDE(Fem::DocumentObject);
};
using FemAnalysisPython = App::FeaturePythonT<FemAnalysis>;
using FeaturePython = App::FeaturePythonT<DocumentObject>;
} // namespace Fem
#endif // Fem_FemAnalysis_H
|