DDS_DicItem Class Reference

#include <DDS_DicItem.h>

Inheritance diagram for DDS_DicItem:

Inheritance graph

Public Types

typedef TCollection_AsciiString UnitSystem
enum  Type {
  String, Float, Integer, List,
  Unknown
}
enum  Data { MinValue = 0x01, MaxValue = 0x02, DefaultValue = 0x04 }

Public Member Functions

 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 TCollection_AsciiString GetUnits () const
Standard_EXPORT 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 Standard_Integer GetPrecision () const
Standard_EXPORT Standard_Integer GetPrecision (const UnitSystem &) const
Standard_EXPORT TCollection_AsciiString GetFormat (const Standard_Boolean=Standard_True) const
Standard_EXPORT 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 Standard_Real ToSI (const Standard_Real) const
Standard_EXPORT Standard_Real FromSI (const Standard_Real) const
Standard_EXPORT Standard_Real ToSI (const Standard_Real, const UnitSystem &) const
Standard_EXPORT Standard_Real FromSI (const Standard_Real, const UnitSystem &) const
Standard_EXPORT Standard_Boolean HasData (const Standard_Integer) const

Private Member Functions

 DDS_DicItem (const DDS_DicItem &)
void operator= (const DDS_DicItem &)
void FillDataMap (TCollection_AsciiString, const LDOM_Element &, const LDOM_Element &, const LDOM_Element &, const TColStd_SequenceOfAsciiString &)
void PrepareFormats (const TCollection_AsciiString &)
void GetDefaultFormat ()
UnitSystem GetActiveUnitSystem () const
void GetStringFormat (const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, TCollection_AsciiString &)
void GetIntegerFormat (const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const Standard_Character, TCollection_AsciiString &)
void GetFloatFormat (const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const Standard_Character, TCollection_AsciiString &)
void Split (const TCollection_AsciiString &, Handle(TColStd_HArray1OfExtendedString)&)
UnitData * GetUnitData (const UnitSystem &) const
 Handle (TColStd_HArray1OfExtendedString) myListRef
 Handle (TColStd_HArray1OfInteger) myListRefID
 Handle (TColStd_HArray1OfExtendedString) myListRefIcons
 Handle (Standard_Transient) myComponent

Private Attributes

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
TCollection_ExtendedString myListName
Standard_Real myMinZoom
Standard_Real myMaxZoom
Standard_Real myZoomOrder
NCollection_DataMap< UnitSystem,
UnitData > 		myUnitData

Friends

class DDS_DicGroup

Data Structures

struct  UnitData

Member Typedef Documentation

typedef TCollection_AsciiString DDS_DicItem.UnitSystem
 

Member Enumeration Documentation

enum DDS_DicItem::Type
 

Enumerator:
String 
Float 
Integer 
List 
Unknown 

enum DDS_DicItem::Data
 

Enumerator:
MinValue 
MaxValue 
DefaultValue 

Constructor & Destructor Documentation

MMgt_TShared DDS_DicItem::DDS_DicItem (   ) 
 

DDS_DicItem::DDS_DicItem (  const DDS_DicItem &   )  [private]
 

Member Function Documentation

TCollection_AsciiString DDS_DicItem::GetId (   )  const
 

DDS_DicItem::Type DDS_DicItem::GetType (   )  const
 

TCollection_ExtendedString DDS_DicItem::GetLabel (   )  const
 

TCollection_ExtendedString DDS_DicItem::GetFilter (   )  const
 

TCollection_ExtendedString DDS_DicItem::GetRequired (   )  const
 

DDS_MsgType DDS_DicItem::GetWarningLevel (   )  const
 

TCollection_ExtendedString DDS_DicItem::GetLongDescription (   )  const
 

TCollection_ExtendedString DDS_DicItem::GetShortDescription (   )  const
 

TCollection_AsciiString DDS_DicItem::GetComponent (   )  const
 

TCollection_AsciiString DDS_DicItem::GetUnits (   )  const
 

TCollection_AsciiString DDS_DicItem::GetUnits (  const UnitSystem &   )  const
 

TCollection_ExtendedString DDS_DicItem::GetDefaultValue (   )  const
 

TCollection_ExtendedString DDS_DicItem::GetDefaultValue (  const UnitSystem &   )  const
 

Standard_Real DDS_DicItem::GetMinValue (   )  const
 

Standard_Real DDS_DicItem::GetMinValue (  const UnitSystem &   )  const
 

Standard_Real DDS_DicItem::GetMaxValue (   )  const
 

Standard_Real DDS_DicItem::GetMaxValue (  const UnitSystem &   )  const
 

Standard_Integer DDS_DicItem::GetPrecision (   )  const
 

Standard_Integer DDS_DicItem::GetPrecision (  const UnitSystem &   )  const
 

TCollection_AsciiString DDS_DicItem::GetFormat (  const   Standard_Boolean = Standard_True  )  const
 

TCollection_AsciiString DDS_DicItem::GetFormat (  const UnitSystem &  ,
const   Standard_Boolean = Standard_True
)  const
 

TCollection_ExtendedString DDS_DicItem::GetNameOfValues (   )  const
 

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_Boolean DDS_DicItem::GetListOfValues (  Handle(TColStd_HArray1OfExtendedString)&  theStrings,
Handle(TColStd_HArray1OfInteger)&  theIntegers
)  const
 

Access valueList of the parameter. This sequence is empty if the list is not defined - then use other properties: Type, DefaultValue, MaxValue, MinValue

Standard_Boolean DDS_DicItem::GetListOfValues (  Handle(TColStd_HArray1OfExtendedString)&  theStrings,
Handle(TColStd_HArray1OfInteger)&  theIntegers,
Handle(TColStd_HArray1OfExtendedString)&  theIcons
)  const
 

Access valueList of the parameter. This sequence is empty if the list is not defined - then use other properties: Type, DefaultValue, MaxValue, MinValue

Standard_Boolean DDS_DicItem::GetSpecialValues (  TColStd_MapOfReal &   )  const
 

Standard_Real DDS_DicItem::GetMinZoom (   )  const
 

Returns min value of lateral zooming

Standard_Real DDS_DicItem::GetMaxZoom (   )  const
 

Returns Max Value of lateral zooming

Standard_Real DDS_DicItem::GetZoomOrder (   )  const
 

Get Order of lateral zooming

Standard_Real DDS_DicItem::ToSI (  const   Standard_Real  )  const
 

Standard_Real DDS_DicItem::FromSI (  const   Standard_Real  )  const
 

Standard_Real DDS_DicItem::ToSI (  const   Standard_Real,
const UnitSystem &  theUnitsSystem
)  const
 

Convert value to default SI units according to current units

Standard_Real DDS_DicItem::FromSI (  const   Standard_Real,
const UnitSystem &  theUnitsSystem
)  const
 

Convert value from default SI units according to current units

Standard_Boolean DDS_DicItem::HasData (  const   Standard_Integer  )  const
 

Returns 'true' if specified data exist.

void DDS_DicItem::operator= (  const DDS_DicItem &   )  [private]
 

void DDS_DicItem::FillDataMap (  TCollection_AsciiString  theID,
const LDOM_Element &  theDatum,
const LDOM_Element &  theCompElement,
const LDOM_Element &  theDocElement,
const TColStd_SequenceOfAsciiString &  theSystems
)  [private]
 

Parse record in XML file and retrieve information relevant for this data dic item

void DDS_DicItem::PrepareFormats (  const TCollection_AsciiString &  theFormat  )  [private]
 

Prepares three formants for each unit systems

void DDS_DicItem::GetDefaultFormat (   )  [private]
 

Returns default formats for each unit systems

DDS_DicItem::UnitSystem DDS_DicItem::GetActiveUnitSystem (   )  const [private]
 

void DDS_DicItem::GetStringFormat (  const TCollection_AsciiString &  theFlags,
const TCollection_AsciiString &  theWidth,
const TCollection_AsciiString &  thePrecision,
const TCollection_AsciiString &  theTypePrefix,
TCollection_AsciiString &  theFormat
)  [private]
 

Returns format for the string

void DDS_DicItem::GetIntegerFormat (  const TCollection_AsciiString &  theFlags,
const TCollection_AsciiString &  theWidth,
const TCollection_AsciiString &  thePrecision,
const TCollection_AsciiString &  theTypePrefix,
const   Standard_Character,
TCollection_AsciiString &  theFormat
)  [private]
 

Returns format for the integer

void DDS_DicItem::GetFloatFormat (  const TCollection_AsciiString &  theFlags,
const TCollection_AsciiString &  theWidth,
const TCollection_AsciiString &  thePrecision,
const TCollection_AsciiString &  theTypePrefix,
const   Standard_Character,
TCollection_AsciiString &  theFormat
)  [private]
 

Returns format for the float

void DDS_DicItem::Split (  const TCollection_AsciiString &  ,
Handle(TColStd_HArray1OfExtendedString)& 
)  [private]
 

DDS_DicItem::UnitData * DDS_DicItem::GetUnitData (  const UnitSystem &   )  const [private]
 

DDS_DicItem.Handle (  TColStd_HArray1OfExtendedString   )  [private]
 

DDS_DicItem.Handle (  TColStd_HArray1OfInteger   )  [private]
 

DDS_DicItem.Handle (  TColStd_HArray1OfExtendedString   )  [private]
 

DDS_DicItem.Handle (  Standard_Transient   )  [private]
 

Friends And Related Function Documentation

friend class DDS_DicGroup [friend]
 

Field Documentation

TCollection_AsciiString DDS_DicItem.myId [private]
 

TCollection_ExtendedString DDS_DicItem.myLabel [private]
 

TCollection_ExtendedString DDS_DicItem.myFilter [private]
 

TCollection_ExtendedString DDS_DicItem.myRequired [private]
 

Standard_Integer DDS_DicItem.myType [private]
 

Standard_Integer DDS_DicItem.myWarnLevel [private]
 

TCollection_ExtendedString DDS_DicItem.myLongDescr [private]
 

TCollection_ExtendedString DDS_DicItem.myShortDescr [private]
 

Standard_Real DDS_DicItem.myMax [private]
 

Standard_Real DDS_DicItem.myMin [private]
 

Standard_Real DDS_DicItem.myDefValue [private]
 

TCollection_ExtendedString DDS_DicItem.myDefString [private]
 

Standard_Integer DDS_DicItem.myData [private]
 

TCollection_ExtendedString DDS_DicItem.myListName [private]
 

Standard_Real DDS_DicItem.myMinZoom [private]
 

Standard_Real DDS_DicItem.myMaxZoom [private]
 

Standard_Real DDS_DicItem.myZoomOrder [private]
 

NCollection_DataMap<UnitSystem, UnitData> DDS_DicItem.myUnitData [private]
 

Generated on Mon Sep 18 18:08:52 2006 for SALOME - GUI - v.3.2.2 by doxygen 1.4.6