SReportData.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SComp.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SReportData : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public:
    enum AngleUnit
    {
        Radian,
        Degree,
        Gradian,
        Percent,
        Minute,
        Second
    };
 
    enum LengthUnit
    {
        Micrometer,
        Millimeter,
        Centimeter,
        Meter,
        Kilometer,
        Microinch,
        Milliinch,
        Inch,
        Feet,
        SurveyFeet,
        Yard,
        Miles
    };
 
    enum AreaUnit
    {
        SquareMicrometer,
        SquareMillimeter,
        SquareCentimeter,
        SquareMeter,
        SquareKilometer,
        SquareMicroinch,
        SquareMilliinch,
        SquareInch,
        SquareFeet,
        SquareSurveyFeet,
        SquareYard,
        SquareMiles
    };
 
    enum VolumeUnit
    {
        CubicMicrometer,
        CubicMillimeter,
        CubicCentimeter,
        CubicMeter,
        CubicKilometer,
        CubicMicroinch,
        CubicMilliinch,
        CubicInch,
        CubicFeet,
        CubicSurveyFeet,
        CubicYard,
        CubicMiles,
        Liter,
        US_LiquidGallon,
        US_DryGallon,
        US_LiquidBarrel,
        US_DryBarrel,
        US_OilBarrel
    };
 
 
public slots:
 
 
      AddToDoc() ;
 
     UpdateMainViewSet();
 
     AddNumber(
         String iName, 
         Number iNumber 
    );
     AddAngle(
         String iName, 
        AngleUnit angleUnit, 
        Number iAngle 
    );
     AddLength(
         String iName, 
        LengthUnit lengthUnit, 
        Number iLength 
    );
     AddArea(
         String iName, 
        AreaUnit areaUnit, 
        Number iArea 
    );
     AddVolume(
         String iName, 
        VolumeUnit volumeUnit, 
        Number iVolume 
    );
     AddPoint(
         String iName, 
        LengthUnit lengthUnit, 
        SPoint iPoint 
    );
     AddVector(
         String iName, 
        LengthUnit lengthUnit, 
         SVector iVector 
    );
     AddText(
         String iName, 
         String iText 
    );
 
     AddImageFromDisk( String iName,  String iImageFilePath);
 
     AddImage( String iName,  SImage iImage);
 
     AddViewset(
         String iName, 
        SViewSet iViewset 
    );
    Array AddLabels(
         String iName, 
         Array<SLabel> iLabelTable 
    );
 
    Number GetNumber( String iName 
    );
    String GetText( String iKey 
    );
    Number GetAngle( String iName 
    );
    Number GetLength( String iName 
    );
    Number GetArea( String iName 
    );
    Number GetVolume( String iName 
    );
    SPoint GetPoint( String iName 
    );
    SVector GetVector( String iName 
    );
 
    Array ExportTableCSV( String iFilesFolder 
    );
 
     ExportDataXML( String iFilePath 
    );
 
private:
    String _MakeValidKey( String iStrToClean);
};
 
// @brief
// this class allow to wrap static function to SReportData easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SReportData
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
 
    static SReportData New( String iName 
    );
 
 
    static Array FromName( String iName 
    )
    {
        return SComp::GetFromName<SReportData>(iName);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SReportData::_SReportDataDummy);
Q_DECLARE_METATYPE(SReportData);
 
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC