DDS_DicItem.h

Go to the documentation of this file.

// Copyright (C) 2007-2025  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef DDS_DICITEM_H
#define DDS_DICITEM_H
 
#include "DDS.h"
 
#include <Standard_Transient.hxx>
 
#include <TCollection_AsciiString.hxx>
 
#include <TColStd_HArray1OfInteger.hxx>
#include <TColStd_HArray1OfExtendedString.hxx>
 
#include <NCollection_DataMap.hxx>
#include <NCollection_IndexedDataMap.hxx>
 
#include <TColStd_MapOfReal.hxx>
#include <TColStd_SequenceOfInteger.hxx>
#include <TColStd_SequenceOfAsciiString.hxx>
#include <TColStd_SequenceOfExtendedString.hxx>
 
class LDOM_Element;
class DDS_Dictionary;
 
//  Class, containing all information about one parameter:
//  unique    : id
//  obligative: label, type, short description, required
//  optional  : format, units,
//              min value, max value, default value.
 
class DDS_DicItem : public Standard_Transient
{
public:
  enum Type
  {
    String,  
    Float,   
    Integer, 
    List,    
    Unknown  
  };
 
  enum Data
  {
    MinValue = 0x01,    
    MaxValue = 0x02,    
    DefaultValue = 0x04 
  };
 
  // This struct is intended for map of Format, Units, Precision and Scale
  struct UnitData
  {
    Standard_Real           myZero;
    Standard_Real           myScale;
    TCollection_AsciiString myUnits;
    TCollection_AsciiString myFormat;
    Standard_Integer        myPrecision;
  };
 
  typedef TCollection_AsciiString UnitSystem;
 
public:
  Standard_EXPORT DDS_DicItem();
 
  Standard_EXPORT TCollection_AsciiString            GetId() const;
  Standard_EXPORT DDS_DicItem::Type                  GetType() const;
  Standard_EXPORT TCollection_ExtendedString         GetLabel() const;
  Standard_EXPORT TCollection_ExtendedString         GetFilter() const;
  Standard_EXPORT TCollection_ExtendedString         GetRequired() const;
  Standard_EXPORT DDS_MsgType                        GetWarningLevel() const;
  Standard_EXPORT TCollection_ExtendedString         GetLongDescription() const;
  Standard_EXPORT TCollection_ExtendedString         GetShortDescription() const;
  Standard_EXPORT TCollection_AsciiString            GetComponent() const;
 
  Standard_EXPORT virtual TCollection_AsciiString    GetUnits() const;
  Standard_EXPORT virtual TCollection_AsciiString    GetUnits( const UnitSystem& ) const;
 
  Standard_EXPORT TCollection_ExtendedString         GetDefaultValue() const;
  Standard_EXPORT TCollection_ExtendedString         GetDefaultValue( const UnitSystem& ) const;
 
  Standard_EXPORT Standard_Real                      GetMinValue() const;
  Standard_EXPORT Standard_Real                      GetMinValue( const UnitSystem& ) const;
 
  Standard_EXPORT Standard_Real                      GetMaxValue() const;
  Standard_EXPORT Standard_Real                      GetMaxValue( const UnitSystem& ) const;
 
  Standard_EXPORT virtual Standard_Integer           GetPrecision() const;
  Standard_EXPORT virtual Standard_Integer           GetPrecision( const UnitSystem& ) const;
 
  Standard_EXPORT virtual TCollection_AsciiString    GetFormat( const Standard_Boolean = Standard_True ) const;
  Standard_EXPORT virtual TCollection_AsciiString    GetFormat( const UnitSystem&,
                                                                const Standard_Boolean = Standard_True ) const;
  Standard_EXPORT TCollection_ExtendedString         GetNameOfValues() const;
  Standard_EXPORT Standard_Boolean                   GetListOfValues( Handle(TColStd_HArray1OfExtendedString)&,
                                                                      Handle(TColStd_HArray1OfInteger)& ) const;
  Standard_EXPORT Standard_Boolean                   GetListOfValues( Handle(TColStd_HArray1OfExtendedString)&,
                                                                      Handle(TColStd_HArray1OfInteger)&,
                                                                      Handle(TColStd_HArray1OfExtendedString)& ) const;
  Standard_EXPORT Standard_Boolean                   GetSpecialValues( TColStd_MapOfReal& ) const;
 
  Standard_EXPORT Standard_Real                      GetMinZoom() const;
  Standard_EXPORT Standard_Real                      GetMaxZoom() const;
  Standard_EXPORT Standard_Real                      GetZoomOrder() const;
 
  Standard_EXPORT virtual Standard_Real              ToSI( const Standard_Real ) const;
  Standard_EXPORT virtual Standard_Real              FromSI( const Standard_Real ) const;
 
  Standard_EXPORT virtual Standard_Real              ToSI( const Standard_Real, const UnitSystem& ) const;
  Standard_EXPORT virtual Standard_Real              FromSI( const Standard_Real, const UnitSystem& ) const;
 
  Standard_EXPORT Standard_Boolean                   HasData( const Standard_Integer ) const;
 
  Standard_EXPORT TCollection_ExtendedString         GetOption( const TCollection_AsciiString& ) const;
  Standard_EXPORT Standard_Boolean                   GetOptionNames( TColStd_SequenceOfAsciiString& ) const;
 
protected:
  
  Standard_EXPORT void                               SetId( const TCollection_AsciiString& );
 
  Standard_EXPORT void                               SetComponent( const Handle(Standard_Transient)& );
 
  Standard_EXPORT void                               SetLabel( const TCollection_AsciiString& );
 
  Standard_EXPORT void                               SetFilter( const TCollection_AsciiString& );
 
  Standard_EXPORT void                               SetRequired( const TCollection_AsciiString& );
 
  Standard_EXPORT void                               SetWarningLevel( const Standard_Integer& );
 
  Standard_EXPORT void                               SetMinZoom( const Standard_Real& );
  Standard_EXPORT void                               SetMaxZoom( const Standard_Real& );
  Standard_EXPORT void                               SetZoomOrder( const Standard_Real& );
 
  Standard_EXPORT void                               SetShortDescription( const TCollection_ExtendedString& );
  Standard_EXPORT void                               SetLongDescription( const TCollection_ExtendedString& );
 
  Standard_EXPORT bool                               SetOption( const TCollection_AsciiString&, const TCollection_AsciiString& );
  Standard_EXPORT void                               SetType( const DDS_DicItem::Type& );
 
  Standard_EXPORT void                               SetMin( const Standard_Real& );
  Standard_EXPORT void                               SetMax( const Standard_Real& );
 
  Standard_EXPORT void                               SetDefaultValue( const Standard_Real& );
  Standard_EXPORT void                               SetDefaultValue( const TCollection_AsciiString& );
 
  Standard_EXPORT void                               SetListOfValues( const Handle(TColStd_HArray1OfExtendedString)&,
                                                                      const Handle(TColStd_HArray1OfInteger)& );
  Standard_EXPORT void                               SetListOfValues( const Handle(TColStd_HArray1OfExtendedString)&,
                                                                      const Handle(TColStd_HArray1OfInteger)&,
                                                                      const Handle(TColStd_HArray1OfExtendedString)& );
 
protected:
 
  Standard_EXPORT DDS_DicItem( const DDS_DicItem& );
 
  Standard_EXPORT void                               operator=( const DDS_DicItem& );
 
  Standard_EXPORT virtual void                       FillDataMap( TCollection_AsciiString, const LDOM_Element&,
                                                                  const LDOM_Element&, const LDOM_Element&,
                                                                  const TColStd_SequenceOfAsciiString& );
 
private:
 
  Standard_EXPORT void                               PrepareFormats( const TCollection_AsciiString& );
  Standard_EXPORT void                               GetDefaultFormat();
  Standard_EXPORT UnitSystem                         GetActiveUnitSystem() const;
 
  Standard_EXPORT void                               GetStringFormat( const TCollection_AsciiString&,
                                                                      const TCollection_AsciiString&,
                                                                      const TCollection_AsciiString&,
                                                                      const TCollection_AsciiString&,
                                                                      TCollection_AsciiString& );
  Standard_EXPORT void                               GetIntegerFormat( const TCollection_AsciiString&,
                                                                       const TCollection_AsciiString&,
                                                                       const TCollection_AsciiString&,
                                                                       const TCollection_AsciiString&,
                                                                       const Standard_Character,
                                                                       TCollection_AsciiString& );
  Standard_EXPORT void                               GetFloatFormat( const TCollection_AsciiString&,
                                                                      const TCollection_AsciiString&,
                                                                      const TCollection_AsciiString&,
                                                                      const TCollection_AsciiString&,
                                                                      const Standard_Character,
                                                                      TCollection_AsciiString& );
  Standard_EXPORT void                               Split( const TCollection_AsciiString&,
                                                            Handle(TColStd_HArray1OfExtendedString)& );
 
  Standard_EXPORT UnitData*                          GetUnitData( const UnitSystem& ) const;
 
private:
  typedef NCollection_DataMap<TCollection_AsciiString, TCollection_ExtendedString> OptionsMap;
 
private:
  TCollection_AsciiString                    myId;
  TCollection_ExtendedString                 myLabel;
  TCollection_ExtendedString                 myFilter;
  TCollection_ExtendedString                 myRequired;
 
  Standard_Integer                           myType;
  Standard_Integer                           myWarnLevel;
 
  TCollection_ExtendedString                 myLongDescr;
  TCollection_ExtendedString                 myShortDescr;
 
  Standard_Real                              myMax;
  Standard_Real                              myMin;
  Standard_Real                              myDefValue;
  TCollection_ExtendedString                 myDefString;
 
  Standard_Integer                           myData;
 
  // valueList
  TCollection_ExtendedString                 myListName;
 
  Handle(TColStd_HArray1OfExtendedString)    myListRef;
  Handle(TColStd_HArray1OfInteger)           myListRefID;
  Handle(TColStd_HArray1OfExtendedString)    myListRefIcons;
 
  // presentation
  Standard_Real                              myMinZoom;
  Standard_Real                              myMaxZoom;
  Standard_Real                              myZoomOrder;
 
  Handle(Standard_Transient)                 myComponent;
 
  OptionsMap                                 myOptions;
  // unitData
  NCollection_DataMap<UnitSystem, UnitData>  myUnitData;
 
  friend class DDS_DicGroup;
 
public:
  DEFINE_STANDARD_RTTIEXT(DDS_DicItem, Standard_Transient)
};
 
DEFINE_STANDARD_HANDLE(DDS_DicItem, Standard_Transient)
 
typedef NCollection_IndexedDataMap<TCollection_AsciiString, Handle(DDS_DicItem)> DDS_IndexedDataMapOfDicItems;
 
#endif