+// Copyright (C) 2007-2023 CEA/DEN, EDF R&D, 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 <MMgt_TShared.hxx>
+#include <Standard_Transient.hxx>
#include <TCollection_AsciiString.hxx>
#include <NCollection_DataMap.hxx>
#include <NCollection_DefineIndexedDataMap.hxx>
+#include <TColStd_MapOfReal.hxx>
+#include <TColStd_SequenceOfInteger.hxx>
+#include <TColStd_SequenceOfAsciiString.hxx>
+#include <TColStd_SequenceOfExtendedString.hxx>
+
class LDOM_Element;
class DDS_Dictionary;
-class TColStd_MapOfReal;
-class TColStd_SequenceOfInteger;
-class TColStd_SequenceOfAsciiString;
-class TColStd_SequenceOfExtendedString;
// Class, containing all information about one parameter:
// unique : id
// optional : format, units,
// min value, max value, default value.
-class DDS_DicItem : public MMgt_TShared
+class DDS_DicItem : public Standard_Transient
{
public:
- enum Type { String, Float, Integer, List, Unknown };
- enum Data { MinValue = 0x01, MaxValue = 0x02, DefaultValue = 0x04 };
+ /*! Enum describes type of datum value */
+ enum Type
+ {
+ String, //!< String type of value
+ Float, //!< Real (double) numeric type of value
+ Integer, //!< Integer (int) numeric type of value
+ List, //!< List type of enumerable value
+ Unknown //!< Unknown or undefined type of value
+ };
+
+ /*! Enum describes the flags for existance of domain data */
+ enum Data
+ {
+ MinValue = 0x01, //!< Flag of minimum value definition existence
+ MaxValue = 0x02, //!< Flag of maximum value definition existence
+ DefaultValue = 0x04 //!< Flag of default value definition existence
+ };
// This struct is intended for map of Format, Units, Precision and Scale
struct UnitData
typedef TCollection_AsciiString UnitSystem;
public:
- DDS_DicItem();
-
- Standard_EXPORT TCollection_AsciiString GetId() const;
- // to access Type of the parameter
+ Standard_EXPORT DDS_DicItem();
- Standard_EXPORT DDS_DicItem::Type GetType() const;
- // to access Type of the parameter
+ 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 TCollection_ExtendedString GetLabel() const;
- // to access Label (name) of the parameter
+ Standard_EXPORT virtual TCollection_AsciiString GetUnits() const;
+ Standard_EXPORT virtual TCollection_AsciiString GetUnits( const UnitSystem& ) const;
- Standard_EXPORT TCollection_ExtendedString GetFilter() const;
- // to access filter (regexp) for the parameter values
+ Standard_EXPORT TCollection_ExtendedString GetDefaultValue() const;
+ Standard_EXPORT TCollection_ExtendedString GetDefaultValue( const UnitSystem& ) const;
- Standard_EXPORT TCollection_ExtendedString GetRequired() const;
- // to access Required of the parameter
+ Standard_EXPORT Standard_Real GetMinValue() const;
+ Standard_EXPORT Standard_Real GetMinValue( const UnitSystem& ) const;
- Standard_EXPORT DDS_MsgType GetWarningLevel() const;
- // to access wrong value warning level of the parameter
+ Standard_EXPORT Standard_Real GetMaxValue() const;
+ Standard_EXPORT Standard_Real GetMaxValue( const UnitSystem& ) const;
- Standard_EXPORT TCollection_ExtendedString GetLongDescription() const;
- // to access Long Description of the parameter
+ Standard_EXPORT virtual Standard_Integer GetPrecision() const;
+ Standard_EXPORT virtual Standard_Integer GetPrecision( const UnitSystem& ) const;
- Standard_EXPORT TCollection_ExtendedString GetShortDescription() const;
- // to access Short Description of the parameter
+ 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 TCollection_AsciiString GetComponent() const;
+ Standard_EXPORT Standard_Real GetMinZoom() const;
+ Standard_EXPORT Standard_Real GetMaxZoom() const;
+ Standard_EXPORT Standard_Real GetZoomOrder() const;
- Standard_EXPORT TCollection_AsciiString GetUnits() const;
- Standard_EXPORT TCollection_AsciiString GetUnits( const UnitSystem& ) const;
- // returns units for indicated unit systems
+ Standard_EXPORT virtual Standard_Real ToSI( const Standard_Real ) const;
+ Standard_EXPORT virtual Standard_Real FromSI( const Standard_Real ) const;
- Standard_EXPORT TCollection_ExtendedString GetDefaultValue() const;
- Standard_EXPORT TCollection_ExtendedString GetDefaultValue( const UnitSystem& ) const;
- // to access Default Value of the parameter
+ 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_Real GetMinValue() const;
- Standard_EXPORT Standard_Real GetMinValue( const UnitSystem& ) const;
- // get Min Value of the parameter, either in specified unit system or in internal units (basic SI)
+ Standard_EXPORT Standard_Boolean HasData( const Standard_Integer ) const;
- Standard_EXPORT Standard_Real GetMaxValue() const;
- Standard_EXPORT Standard_Real GetMaxValue( const UnitSystem& ) const;
- // get Max Value of the parameter, either in specified unit system or in internal units (basic SI)
+ Standard_EXPORT TCollection_ExtendedString GetOption( const TCollection_AsciiString& ) const;
+ Standard_EXPORT Standard_Boolean GetOptionNames( TColStd_SequenceOfAsciiString& ) const;
- Standard_EXPORT Standard_Integer GetPrecision() const;
- Standard_EXPORT Standard_Integer GetPrecision( const UnitSystem& ) const;
- // returns precision for indicated unit systems
+protected:
+
+ Standard_EXPORT void SetId( const TCollection_AsciiString& );
- Standard_EXPORT TCollection_AsciiString GetFormat( const Standard_Boolean = Standard_True ) const;
- Standard_EXPORT TCollection_AsciiString GetFormat( const UnitSystem&,
- const Standard_Boolean = Standard_True ) const;
- // returns format for indicated unit systems
+ Standard_EXPORT void SetComponent( const Handle(Standard_Transient)& );
- Standard_EXPORT TCollection_ExtendedString GetNameOfValues() const;
- // to access valueList:name of the parameter.
- // This string is void if the list is not defined - then use other properties:
- // Type, DefaultValue, MaxValue, MinValue
+ Standard_EXPORT void SetLabel( const TCollection_AsciiString& );
- Standard_EXPORT Standard_Boolean GetListOfValues( Handle(TColStd_HArray1OfExtendedString)&,
- Handle(TColStd_HArray1OfInteger)& ) const;
- // to access valueList of the parameter
- // This sequence is empty if the list not defined - then use other properties:
- // Type, DefaultValue, MaxValue, MinValue
+ Standard_EXPORT void SetFilter( const TCollection_AsciiString& );
- Standard_EXPORT Standard_Boolean GetListOfValues( Handle(TColStd_HArray1OfExtendedString)&,
- Handle(TColStd_HArray1OfInteger)&,
- Handle(TColStd_HArray1OfExtendedString)& ) const;
- // to access valueList of the parameter
- // This sequence is empty if the list not defined - then use other properties:
- // Type, DefaultValue, MaxValue, MinValue
+ Standard_EXPORT void SetRequired( const TCollection_AsciiString& );
- Standard_EXPORT Standard_Boolean GetSpecialValues( TColStd_MapOfReal& ) const;
- // get values from specVal
+ Standard_EXPORT void SetWarningLevel( const Standard_Integer& );
- Standard_EXPORT Standard_Real GetMinZoom() const;
- // get Min Value of lateral zooming
+ Standard_EXPORT void SetMinZoom( const Standard_Real& );
+ Standard_EXPORT void SetMaxZoom( const Standard_Real& );
+ Standard_EXPORT void SetZoomOrder( const Standard_Real& );
- Standard_EXPORT Standard_Real GetMaxZoom() const;
- // get Max Value of lateral zooming
+ Standard_EXPORT void SetShortDescription( const TCollection_ExtendedString& );
+ Standard_EXPORT void SetLongDescription( const TCollection_ExtendedString& );
- Standard_EXPORT Standard_Real GetZoomOrder() const;
- // get Order of lateral zooming
+ Standard_EXPORT bool SetOption( const TCollection_AsciiString&, const TCollection_AsciiString& );
+ Standard_EXPORT void SetType( const DDS_DicItem::Type& );
- Standard_EXPORT Standard_Real ToSI( const Standard_Real ) const;
- Standard_EXPORT Standard_Real FromSI( const Standard_Real ) const;
+ Standard_EXPORT void SetMin( const Standard_Real& );
+ Standard_EXPORT void SetMax( const Standard_Real& );
- Standard_EXPORT Standard_Real ToSI( const Standard_Real, const UnitSystem& ) const;
- Standard_EXPORT Standard_Real FromSI( const Standard_Real, const UnitSystem& ) const;
- // convert value to and from default SI units according to current units
+ Standard_EXPORT void SetDefaultValue( const Standard_Real& );
+ Standard_EXPORT void SetDefaultValue( const TCollection_AsciiString& );
- Standard_EXPORT Standard_Boolean HasData( const Standard_Integer ) const;
-
-private:
- DDS_DicItem( const DDS_DicItem& );
- // Copy constructor
-
- void operator=( const DDS_DicItem& );
- // Assignment operator
-
- void FillDataMap( TCollection_AsciiString, const LDOM_Element&,
- const LDOM_Element&, const LDOM_Element&,
- const TColStd_SequenceOfAsciiString& );
- // prepares formants for each unit systems
+ 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:
- void PrepareFormats( const TCollection_AsciiString& );
- // prepares three formats for each unit systems
+ Standard_EXPORT DDS_DicItem( const DDS_DicItem& );
- void GetDefaultFormat();
- // returns three default formants for each unit systems
+ Standard_EXPORT void operator=( const DDS_DicItem& );
- UnitSystem GetActiveUnitSystem() const;
+ Standard_EXPORT virtual void FillDataMap( TCollection_AsciiString, const LDOM_Element&,
+ const LDOM_Element&, const LDOM_Element&,
+ const TColStd_SequenceOfAsciiString& );
- void GetStringFormat( const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- TCollection_AsciiString& );
- // returns format for the string
-
- void GetIntegerFormat( const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const Standard_Character,
- TCollection_AsciiString& );
- // returns format for the integer
-
- void GetFloatFormat( const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const TCollection_AsciiString&,
- const Standard_Character,
- TCollection_AsciiString& );
- // returns format for the float
+private:
- void Split( const TCollection_AsciiString&,
- Handle(TColStd_HArray1OfExtendedString)& );
+ 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;
- UnitData* GetUnitData( const UnitSystem& ) const;
+private:
+ typedef NCollection_DataMap<TCollection_AsciiString, TCollection_ExtendedString> OptionsMap;
private:
TCollection_AsciiString myId;
Handle(Standard_Transient) myComponent;
+ OptionsMap myOptions;
// unitData
NCollection_DataMap<UnitSystem, UnitData> myUnitData;
friend class DDS_DicGroup;
public:
- // Declaration of CASCADE RTTI
- DEFINE_STANDARD_RTTI(DDS_DicItem)
+ DEFINE_STANDARD_RTTIEXT(DDS_DicItem, Standard_Transient)
};
-// Definition of HANDLE object using Standard_DefineHandle.hxx
-DEFINE_STANDARD_HANDLE(DDS_DicItem, MMgt_TShared)
+DEFINE_STANDARD_HANDLE(DDS_DicItem, Standard_Transient)
-// Container class XMLTools_IndexedDataMapOfDicItems (map of handles)
-DEFINE_BASECOLLECTION(DDS_BaseCollectionOfDicItems, Handle(DDS_DicItem))
-DEFINE_INDEXEDDATAMAP(DDS_IndexedDataMapOfDicItems, DDS_BaseCollectionOfDicItems,
- TCollection_AsciiString, Handle(DDS_DicItem))
+typedef NCollection_IndexedDataMap<TCollection_AsciiString, Handle(DDS_DicItem)> DDS_IndexedDataMapOfDicItems;
#endif
