DDS_DicItem Class Reference

This class provides an information about datum (phisical characteristic parameter). More...

#include <DDS_DicItem.h>

Inheritance diagram for DDS_DicItem:

Classes
struct	UnitData

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

Public Member Functions
Standard_EXPORT	DDS_DicItem ()
Standard_EXPORT TCollection_AsciiString	GetId () const
	Get the identifier of parameter. More...
Standard_EXPORT DDS_DicItem::Type	GetType () const
	Get the type of parameter. More...
Standard_EXPORT TCollection_ExtendedString	GetLabel () const
	Get the label of the parameter. More...
Standard_EXPORT TCollection_ExtendedString	GetFilter () const
	Get the filter (regular expression) for the parameter values. More...
Standard_EXPORT TCollection_ExtendedString	GetRequired () const
	Get the Required attribute of the parameter. More...
Standard_EXPORT DDS_MsgType	GetWarningLevel () const
	Get the wrong value warning level of the parameter. More...
Standard_EXPORT TCollection_ExtendedString	GetLongDescription () const
	Get the long description of the parameter. More...
Standard_EXPORT TCollection_ExtendedString	GetShortDescription () const
	Get the short description of the parameter. More...
Standard_EXPORT TCollection_AsciiString	GetComponent () const
	Get the name of the component (parameter owner). More...
virtual Standard_EXPORT TCollection_AsciiString	GetUnits () const
	Get the parameter measure units for active units system. More...
virtual Standard_EXPORT TCollection_AsciiString	GetUnits (const UnitSystem &) const
	Get the parameter measure units for specified units system theSystem. More...
Standard_EXPORT TCollection_ExtendedString	GetDefaultValue () const
	Get the default value of the parameter for active units system. More...
Standard_EXPORT TCollection_ExtendedString	GetDefaultValue (const UnitSystem &) const
	Get the default value of the parameter for specified units system theSystem. More...
Standard_EXPORT Standard_Real	GetMinValue () const
	Get the minimum value of the parameter for active units system. More...
Standard_EXPORT Standard_Real	GetMinValue (const UnitSystem &) const
	Get the minimum value of the parameter for the specified units system theSystem. More...
Standard_EXPORT Standard_Real	GetMaxValue () const
	Get the maximum value of the parameter for active units system. More...
Standard_EXPORT Standard_Real	GetMaxValue (const UnitSystem &) const
	Get the maximum value of the parameter for specified units system theSystem. More...
virtual Standard_EXPORT Standard_Integer	GetPrecision () const
	Get the precision (number of digits after decimal point) of the parameter for active units system. More...
virtual Standard_EXPORT Standard_Integer	GetPrecision (const UnitSystem &) const
	Get the precision (number of digits after decimal point) of the parameter for specified units system theSystem. More...
virtual Standard_EXPORT TCollection_AsciiString	GetFormat (const Standard_Boolean=Standard_True) const
	Get the format string of the parameter for active units system. More...
virtual Standard_EXPORT TCollection_AsciiString	GetFormat (const UnitSystem &, const Standard_Boolean=Standard_True) const
	Get the format string of the parameter for specified units system theSystem. More...
Standard_EXPORT TCollection_ExtendedString	GetNameOfValues () const
	Get the name of a list referenced by the parameter. More...
Standard_EXPORT Standard_Boolean	GetListOfValues (Handle(TColStd_HArray1OfExtendedString)&, Handle(TColStd_HArray1OfInteger)&) const
	Get item names and item identifiers of a list referenced by the parameter. More...
Standard_EXPORT Standard_Boolean	GetListOfValues (Handle(TColStd_HArray1OfExtendedString)&, Handle(TColStd_HArray1OfInteger)&, Handle(TColStd_HArray1OfExtendedString)&) const
	Get item names, item identifiers and item icons of a list referenced by the parameter. More...
Standard_EXPORT Standard_Boolean	GetSpecialValues (TColStd_MapOfReal &) const
	Get special values of the parameter. More...
Standard_EXPORT Standard_Real	GetMinZoom () const
	Get minimum value of lateral zooming. More...
Standard_EXPORT Standard_Real	GetMaxZoom () const
	Get maximum value of lateral zooming. More...
Standard_EXPORT Standard_Real	GetZoomOrder () const
	Get order of lateral zooming. More...
virtual Standard_EXPORT Standard_Real	ToSI (const Standard_Real) const
	Convert value theVal to the default SI units according to the active units system. More...
virtual Standard_EXPORT Standard_Real	FromSI (const Standard_Real) const
	Convert value theVal from the default SI units according to the active units system. More...
virtual Standard_EXPORT Standard_Real	ToSI (const Standard_Real, const UnitSystem &) const
	Convert value to the default SI units according to the units system theUnitsSystem. More...
virtual Standard_EXPORT Standard_Real	FromSI (const Standard_Real, const UnitSystem &) const
	Convert value from the default SI units according to the units system theUnitsSystem. More...
Standard_EXPORT Standard_Boolean	HasData (const Standard_Integer) const
	Check data existence. More...
Standard_EXPORT TCollection_ExtendedString	GetOption (const TCollection_AsciiString &) const
	Get option for specified name name. More...
Standard_EXPORT Standard_Boolean	GetOptionNames (TColStd_SequenceOfAsciiString &) const
	Get names of all existing options. More...

Protected Member Functions
Standard_EXPORT void	SetId (const TCollection_AsciiString &)
	Set item's identify string. More...
Standard_EXPORT void	SetComponent (const Handle(Standard_Transient)&)
	Set item's component pointer. More...
Standard_EXPORT void	SetLabel (const TCollection_AsciiString &)
	Set item's label string. More...
Standard_EXPORT void	SetFilter (const TCollection_AsciiString &)
	Set item's filter string. More...
Standard_EXPORT void	SetRequired (const TCollection_AsciiString &)
	Set item's required value. More...
Standard_EXPORT void	SetWarningLevel (const Standard_Integer &)
	Set item's warning level value. More...
Standard_EXPORT void	SetMinZoom (const Standard_Real &)
	Set item's minimum zoom value. More...
Standard_EXPORT void	SetMaxZoom (const Standard_Real &)
	Set item's maximum zoom value. More...
Standard_EXPORT void	SetZoomOrder (const Standard_Real &)
	Set item's zoom order value. More...
Standard_EXPORT void	SetShortDescription (const TCollection_ExtendedString &)
	Set item's short description. More...
Standard_EXPORT void	SetLongDescription (const TCollection_ExtendedString &)
	Set item's long description. More...
Standard_EXPORT bool	SetOption (const TCollection_AsciiString &, const TCollection_AsciiString &)
	Add item's option. More...
Standard_EXPORT void	SetType (const DDS_DicItem::Type &)
	Set item's type value. More...
Standard_EXPORT void	SetMin (const Standard_Real &)
	Set item's minimum value. More...
Standard_EXPORT void	SetMax (const Standard_Real &)
	Set item's maximum value. More...
Standard_EXPORT void	SetDefaultValue (const Standard_Real &)
	Set item's default value as a real number. More...
Standard_EXPORT void	SetDefaultValue (const TCollection_AsciiString &)
	Set item's default value as a string. More...
Standard_EXPORT void	SetListOfValues (const Handle(TColStd_HArray1OfExtendedString)&, const Handle(TColStd_HArray1OfInteger)&)
	Set item's value list. More...
Standard_EXPORT void	SetListOfValues (const Handle(TColStd_HArray1OfExtendedString)&, const Handle(TColStd_HArray1OfInteger)&, const Handle(TColStd_HArray1OfExtendedString)&)
	Set item's value list and icons. More...
Standard_EXPORT	DDS_DicItem (const DDS_DicItem &)
	Copy constructor (put in private section to prevent object copying). More...
Standard_EXPORT void	operator= (const DDS_DicItem &)
	Assignment operator (put in private section to prevent object copying). More...
virtual Standard_EXPORT void	FillDataMap (TCollection_AsciiString, const LDOM_Element &, const LDOM_Element &, const LDOM_Element &, const TColStd_SequenceOfAsciiString &)
	Parse record from XML file and retrieve information relevant for the dictionary item. More...

Private Types
typedef NCollection_DataMap< TCollection_AsciiString, TCollection_ExtendedString >	OptionsMap

Private Member Functions
Standard_EXPORT void	PrepareFormats (const TCollection_AsciiString &)
	Prepare formats for all units systems. More...
Standard_EXPORT void	GetDefaultFormat ()
	Restore default formats for all the units systems. More...
Standard_EXPORT UnitSystem	GetActiveUnitSystem () const
	Get the active units system. More...
Standard_EXPORT void	GetStringFormat (const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, TCollection_AsciiString &)
	Get format for the string. More...
Standard_EXPORT void	GetIntegerFormat (const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const Standard_Character, TCollection_AsciiString &)
	Get format for the integer. More...
Standard_EXPORT void	GetFloatFormat (const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const TCollection_AsciiString &, const Standard_Character, TCollection_AsciiString &)
	Returns format for the float. More...
Standard_EXPORT void	Split (const TCollection_AsciiString &, Handle(TColStd_HArray1OfExtendedString)&)
	Split the string theStr separated by spaces. More...
Standard_EXPORT UnitData *	GetUnitData (const UnitSystem &) const
	Get units structure for specified units system sys. More...
	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
OptionsMap	myOptions
NCollection_DataMap< UnitSystem, UnitData >	myUnitData

Friends
class	DDS_DicGroup

Detailed Description

This class provides an information about datum (phisical characteristic parameter).

Member Typedef Documentation

OptionsMap

typedef NCollection_DataMap<TCollection_AsciiString, TCollection_ExtendedString> DDS_DicItem::OptionsMap

private

UnitSystem

typedef TCollection_AsciiString DDS_DicItem::UnitSystem

Member Enumeration Documentation

Data

enum DDS_DicItem::Data

Enum describes the flags for existance of domain data

Enumerator
MinValue	Flag of minimum value definition existence.
MaxValue	Flag of maximum value definition existence.
DefaultValue	Flag of default value definition existence.

Type

enum DDS_DicItem::Type

Enum describes type of datum value

Enumerator
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.

Constructor & Destructor Documentation

DDS_DicItem() [1/2]

Standard_EXPORT DDS_DicItem::DDS_DicItem

(

)

DDS_DicItem() [2/2]

DDS_DicItem::DDS_DicItem ( const DDS_DicItem &  )

protected

Copy constructor (put in private section to prevent object copying).

Member Function Documentation

FillDataMap()

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

protectedvirtual

Parse record from XML file and retrieve information relevant for the dictionary item.

Parameters

theID	item identifier
theDatum	datum XML node
theCompElement	component XML node
theDocElement	document XML node
theSystems	units system names

References DDS_MT_ALARM, DDS_MT_ERROR, DDS_MT_INFO, DDS_MT_NONE, DDS_MT_WARNING, DefaultValue, Float, Handle(), Integer, List, MaxValue, MinValue, myData, myDefString, myDefValue, myFilter, myId, myLabel, myListName, myLongDescr, myMax, myMaxZoom, myMin, myMinZoom, myOptions, myRequired, DDS_DicItem::UnitData::myScale, myShortDescr, myType, myUnitData, DDS_DicItem::UnitData::myUnits, myWarnLevel, DDS_DicItem::UnitData::myZero, myZoomOrder, PrepareFormats(), Split(), String, and Unknown.

FromSI() [1/2]

Standard_Real DDS_DicItem::FromSI ( const Standard_Real  theVal ) const

virtual

Convert value theVal from the default SI units according to the active units system.

Parameters

theVal

value being converted

Returns

value converted from SI

References GetActiveUnitSystem().

FromSI() [2/2]

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

virtual

Convert value from the default SI units according to the units system theUnitsSystem.

Parameters

theVal	value being converted
theUnitsSystem	units system

Returns

value converted from the specified units system

References GetUnitData(), DDS_DicItem::UnitData::myScale, and DDS_DicItem::UnitData::myZero.

GetActiveUnitSystem()

DDS_DicItem::UnitSystem DDS_DicItem::GetActiveUnitSystem ( ) const

private

Get the active units system.

Returns

active units system

References Handle().

GetComponent()

TCollection_AsciiString DDS_DicItem::GetComponent

(

)

const

Get the name of the component (parameter owner).

Returns

component name

References Handle().

GetDefaultFormat()

void DDS_DicItem::GetDefaultFormat ( )

private

Restore default formats for all the units systems.

References Float, Integer, DDS_DicItem::UnitData::myFormat, myType, myUnitData, and String.

GetDefaultValue() [1/2]

TCollection_ExtendedString DDS_DicItem::GetDefaultValue

(

)

const

Get the default value of the parameter for active units system.

Default value is returned as string. If type of the value is numerical (Float or Integer) and default value is defined, then the returning value is converted to SI.

Returns

default value

References GetActiveUnitSystem().

GetDefaultValue() [2/2]

TCollection_ExtendedString DDS_DicItem::GetDefaultValue

(

const UnitSystem &

theSystem

)

const

Get the default value of the parameter for specified units system theSystem.

Default value is returned as string. If type of the value is numerical (Float or Integer) and default value is defined, then the returning value is converted to SI.

Parameters

theSystem

units system

Returns

default value

References Float, FromSI(), Integer, List, myDefString, myDefValue, myType, and String.

GetFilter()

TCollection_ExtendedString DDS_DicItem::GetFilter

(

)

const

Get the filter (regular expression) for the parameter values.

Returns

parameter filter

References myFilter.

GetFloatFormat()

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

private

Returns format for the float.

Parameters

theFlags	format flags
theWidth	field width
thePrecision	precision
theTypePrefix	type prefix
theType	floating point value type
theFormat	returning format string

GetFormat() [1/2]

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

virtual

Get the format string of the parameter for active units system.

If argument theCanonical is true, format string is reduced according to the sprintf() specification (without extra non standard qualifiers).

Parameters

theCanonical

'canonical form' flag

Returns

format string

References GetActiveUnitSystem().

GetFormat() [2/2]

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

virtual

Get the format string of the parameter for specified units system theSystem.

If argument theCanonical is true, format string is reduced according to the sprintf() specification (without extra non standard qualifiers).

Parameters

theSystem	units system
theCanonical	'canonical form' flag

Returns

format string

References GetUnitData(), and DDS_DicItem::UnitData::myFormat.

GetId()

TCollection_AsciiString DDS_DicItem::GetId

(

)

const

Get the identifier of parameter.

Returns

parameter ID

References myId.

GetIntegerFormat()

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

private

Get format for the integer.

Parameters

theFlags	format flags
theWidth	field width
thePrecision	precision
theTypePrefix	type prefix
theType	integer value type
theFormat	returning format string

GetLabel()

TCollection_ExtendedString DDS_DicItem::GetLabel

(

)

const

Get the label of the parameter.

Returns

parameter label

References myLabel.

GetListOfValues() [1/2]

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

Get item names and item identifiers of a list referenced by the parameter.

These sequences are empty if the list reference is not defined. In this case, other properties (Type, DefaultValue, MaxValue, MinValue) should be used.

Parameters

theStrings	returning items names
theIntegers	returning items identifiers

Returns

true if returning lists are not empty

See also

GetNameOfValues()

GetListOfValues() [2/2]

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

Get item names, item identifiers and item icons of a list referenced by the parameter.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

These sequences are empty if the list reference is not defined. In this case, other properties (Type, DefaultValue, MaxValue, MinValue) should be used.

Parameters

theStrings	returning items names
theIntegers	returning items identifiers
theIcons	returning items icons

Returns

true if returning lists are not empty

See also

GetNameOfValues()

GetLongDescription()

TCollection_ExtendedString DDS_DicItem::GetLongDescription

(

)

const

Get the long description of the parameter.

Returns

long description

References myLongDescr.

GetMaxValue() [1/2]

Standard_Real DDS_DicItem::GetMaxValue

(

)

const

Get the maximum value of the parameter for active units system.

Returned value converted to SI.

Returns

maximum value

References GetActiveUnitSystem().

GetMaxValue() [2/2]

Standard_Real DDS_DicItem::GetMaxValue

(

const UnitSystem &

theUnitsSystem

)

const

Get the maximum value of the parameter for specified units system theSystem.

Returned value converted to SI.

Parameters

theUnitsSystem

units system

Returns

maximum value

References FromSI(), and myMax.

GetMaxZoom()

Standard_Real DDS_DicItem::GetMaxZoom

(

)

const

Get maximum value of lateral zooming.

Returns

lateral zooming maximum value

References myMaxZoom.

GetMinValue() [1/2]

Standard_Real DDS_DicItem::GetMinValue

(

)

const

Get the minimum value of the parameter for active units system.

Returned value is converted to SI.

Returns

minimum value

References GetActiveUnitSystem().

GetMinValue() [2/2]

Standard_Real DDS_DicItem::GetMinValue

(

const UnitSystem &

theUnitsSystem

)

const

Get the minimum value of the parameter for the specified units system theSystem.

Returned value is converted to SI.

Parameters

theUnitsSystem

units system

Returns

minimum value

References FromSI(), and myMin.

GetMinZoom()

Standard_Real DDS_DicItem::GetMinZoom

(

)

const

Get minimum value of lateral zooming.

Returns

lateral zooming minimum value

References myMinZoom.

GetNameOfValues()

TCollection_ExtendedString DDS_DicItem::GetNameOfValues

(

)

const

Get the name of a list referenced by the parameter.

This string is empty if the list reference is not defined. In this case, other properties (Type, DefaultValue, MaxValue, MinValue) should be used.

Returns

referenced list name

See also

GetListOfValues()

References myListName.

GetOption()

TCollection_ExtendedString DDS_DicItem::GetOption

(

const TCollection_AsciiString &

name

)

const

Get option for specified name name.

If option is not found, empty string is returned.

Parameters

name	option name

Returns

option value

References myOptions.

GetOptionNames()

Standard_Boolean DDS_DicItem::GetOptionNames

(

TColStd_SequenceOfAsciiString &

names

)

const

Get names of all existing options.

Parameters

names

returning list of options

Returns

true if list is not empty

References myOptions.

GetPrecision() [1/2]

Standard_Integer DDS_DicItem::GetPrecision ( ) const

virtual

Get the precision (number of digits after decimal point) of the parameter for active units system.

Returns

parameter precision

References GetActiveUnitSystem().

GetPrecision() [2/2]

Standard_Integer DDS_DicItem::GetPrecision ( const UnitSystem &  theSystem ) const

virtual

Get the precision (number of digits after decimal point) of the parameter for specified units system theSystem.

If specified units system doesn't exist, zero is returned.

Parameters

theSystem

units system

Returns

parameter precision

References GetUnitData(), and DDS_DicItem::UnitData::myPrecision.

GetRequired()

TCollection_ExtendedString DDS_DicItem::GetRequired

(

)

const

Get the Required attribute of the parameter.

Returns

Required attribute

References myRequired.

GetShortDescription()

TCollection_ExtendedString DDS_DicItem::GetShortDescription

(

)

const

Get the short description of the parameter.

Returns

short description

References myShortDescr.

GetSpecialValues()

Standard_Boolean DDS_DicItem::GetSpecialValues

(

TColStd_MapOfReal &

theMap

)

const

Get special values of the parameter.

Parameters

theMap

returning map of the special values

Returns

true if returning map is not empty

GetStringFormat()

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

private

Get format for the string.

Parameters

theFlags	format flags
theWidth	field width
thePrecision	precision
theTypePrefix	type prefix
theFormat	returning format string

GetType()

DDS_DicItem::Type DDS_DicItem::GetType

(

)

const

Get the type of parameter.

Returns

parameter type

References myType.

GetUnitData()

DDS_DicItem::UnitData * DDS_DicItem::GetUnitData ( const UnitSystem &  sys ) const

private

Get units structure for specified units system sys.

Parameters

sys	units system

Returns

units system information structure

References myUnitData.

GetUnits() [1/2]

TCollection_AsciiString DDS_DicItem::GetUnits ( ) const

virtual

Get the parameter measure units for active units system.

Returns

parameter units

References GetActiveUnitSystem().

GetUnits() [2/2]

TCollection_AsciiString DDS_DicItem::GetUnits ( const UnitSystem &  theSystem ) const

virtual

Get the parameter measure units for specified units system theSystem.

If specified units system doesn't exist, empty string is returned.

Parameters

theSystem

units system

Returns

parameter units

References GetUnitData(), and DDS_DicItem::UnitData::myUnits.

GetWarningLevel()

DDS_MsgType DDS_DicItem::GetWarningLevel

(

)

const

Get the wrong value warning level of the parameter.

Returns

warning level

References myWarnLevel.

GetZoomOrder()

Standard_Real DDS_DicItem::GetZoomOrder

(

)

const

Get order of lateral zooming.

Returns

lateral zooming order

References myZoomOrder.

Handle() [1/4]

DDS_DicItem::Handle ( Standard_Transient  )

private

Handle() [2/4]

DDS_DicItem::Handle ( TColStd_HArray1OfExtendedString  )

private

Handle() [3/4]

DDS_DicItem::Handle ( TColStd_HArray1OfExtendedString  )

private

Handle() [4/4]

DDS_DicItem::Handle ( TColStd_HArray1OfInteger  )

private

HasData()

Standard_Boolean DDS_DicItem::HasData

(

const Standard_Integer

flag

)

const

Check data existence.

Parameters

flag

data flag

Returns

true if data specified by flag exists

References myData.

operator=()

void DDS_DicItem::operator= ( const DDS_DicItem &  )

protected

Assignment operator (put in private section to prevent object copying).

PrepareFormats()

void DDS_DicItem::PrepareFormats ( const TCollection_AsciiString &  theFormat )

private

Prepare formats for all units systems.

Parameters

theFormat

format string

References Float, GetDefaultFormat(), GetFloatFormat(), GetIntegerFormat(), GetStringFormat(), Integer, List, DDS_DicItem::UnitData::myFormat, DDS_DicItem::UnitData::myPrecision, myType, myUnitData, DDS_DicItem::UnitData::myUnits, and String.

SetComponent()

void DDS_DicItem::SetComponent ( const Handle(Standard_Transient)&  theComponent )

protected

Set item's component pointer.

Parameters

theComponent

component pointer.

SetDefaultValue() [1/2]

void DDS_DicItem::SetDefaultValue ( const Standard_Real &  theDefVal )

protected

Set item's default value as a real number.

Parameters

theDefVal

default value.

References DefaultValue, myData, and myDefValue.

SetDefaultValue() [2/2]

void DDS_DicItem::SetDefaultValue ( const TCollection_AsciiString &  theDefStr )

protected

Set item's default value as a string.

Parameters

theDefStr

default value.

References myDefString.

SetFilter()

void DDS_DicItem::SetFilter ( const TCollection_AsciiString &  theFilter )

protected

Set item's filter string.

Parameters

theFilter

filter string.

References myFilter.

SetId()

void DDS_DicItem::SetId ( const TCollection_AsciiString &  theId )

protected

Set item's identify string.

Parameters

theId

identify string.

References myId.

SetLabel()

void DDS_DicItem::SetLabel ( const TCollection_AsciiString &  theLabel )

protected

Set item's label string.

Parameters

theLabel

label string.

References myLabel.

SetListOfValues() [1/2]

void DDS_DicItem::SetListOfValues ( const Handle(TColStd_HArray1OfExtendedString)&  theStrings, const Handle(TColStd_HArray1OfInteger)&  theIntegers  )

protected

Set item's value list.

Parameters

theStrings	list of value strings.
theIntegers	list of integer values associated with string item.

SetListOfValues() [2/2]

void DDS_DicItem::SetListOfValues ( const Handle(TColStd_HArray1OfExtendedString)&  theStrings, const Handle(TColStd_HArray1OfInteger)&  theIntegers, const Handle(TColStd_HArray1OfExtendedString)&  theIcons  )

protected

Set item's value list and icons.

Parameters

theStrings	list of value strings.
theIntegers	list of integer values associated with string item.
theIcons	list of icons associated with string item.

SetLongDescription()

void DDS_DicItem::SetLongDescription ( const TCollection_ExtendedString &  theLongDescr )

protected

Set item's long description.

Parameters

theLongDescr

long description string.

References myLongDescr.

SetMax()

void DDS_DicItem::SetMax ( const Standard_Real &  theMaxVal )

protected

Set item's maximum value.

Parameters

theMaxVal

maximum possible value.

References MaxValue, myData, and myMax.

SetMaxZoom()

void DDS_DicItem::SetMaxZoom ( const Standard_Real &  theMaxZoom )

protected

Set item's maximum zoom value.

Parameters

theMaxZoom

maximum zoom value.

References myMaxZoom.

SetMin()

void DDS_DicItem::SetMin ( const Standard_Real &  theMinVal )

protected

Set item's minimum value.

Parameters

theMinVal

minimum possible value.

References MinValue, myData, and myMin.

SetMinZoom()

void DDS_DicItem::SetMinZoom ( const Standard_Real &  theMinZoom )

protected

Set item's minimum zoom value.

Parameters

theMinZoom

minimum zoom value.

References myMinZoom.

SetOption()

bool DDS_DicItem::SetOption ( const TCollection_AsciiString &  theOptionName, const TCollection_AsciiString &  theOptionValue  )

protected

Add item's option.

Parameters

theOptionName	option name string.
theOptionValue	option value string.

References myOptions.

SetRequired()

void DDS_DicItem::SetRequired ( const TCollection_AsciiString &  theRequired )

protected

Set item's required value.

Parameters

theRequired

required value string.

References myRequired.

SetShortDescription()

void DDS_DicItem::SetShortDescription ( const TCollection_ExtendedString &  theShortDescr )

protected

Set item's short description.

Parameters

theShortDescr

short description string.

References myShortDescr.

SetType()

void DDS_DicItem::SetType ( const DDS_DicItem::Type &  theType )

protected

Set item's type value.

Parameters

theType

item value type.

References myType.

SetWarningLevel()

void DDS_DicItem::SetWarningLevel ( const Standard_Integer &  theWarningLevel )

protected

Set item's warning level value.

Parameters

theWarningLevel

warning level value.

References myWarnLevel.

SetZoomOrder()

void DDS_DicItem::SetZoomOrder ( const Standard_Real &  theZoomOrder )

protected

Set item's zoom order value.

Parameters

theZoomOrder

zoom order value.

References myZoomOrder.

Split()

void DDS_DicItem::Split ( const TCollection_AsciiString &  theStr, Handle(TColStd_HArray1OfExtendedString)&  aRes  )

private

Split the string theStr separated by spaces.

Parameters

theStr	source string
aRes	returning substrings array

ToSI() [1/2]

Standard_Real DDS_DicItem::ToSI ( const Standard_Real  theVal ) const

virtual

Convert value theVal to the default SI units according to the active units system.

Parameters

theVal

value being converted

Returns

value converted to SI

References GetActiveUnitSystem().

ToSI() [2/2]

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

virtual

Convert value to the default SI units according to the units system theUnitsSystem.

Parameters

theVal	value being converted
theUnitsSystem	units system

Returns

value converted to the specified units system

References GetUnitData(), DDS_DicItem::UnitData::myScale, and DDS_DicItem::UnitData::myZero.

Friends And Related Function Documentation

DDS_DicGroup

friend class DDS_DicGroup

friend

Member Data Documentation

myData

Standard_Integer DDS_DicItem::myData

private

myDefString

TCollection_ExtendedString DDS_DicItem::myDefString

private

myDefValue

Standard_Real DDS_DicItem::myDefValue

private

myFilter

TCollection_ExtendedString DDS_DicItem::myFilter

private

myId

TCollection_AsciiString DDS_DicItem::myId

private

myLabel

TCollection_ExtendedString DDS_DicItem::myLabel

private

myListName

TCollection_ExtendedString DDS_DicItem::myListName

private

myLongDescr

TCollection_ExtendedString DDS_DicItem::myLongDescr

private

myMax

Standard_Real DDS_DicItem::myMax

private

myMaxZoom

Standard_Real DDS_DicItem::myMaxZoom

private

myMin

Standard_Real DDS_DicItem::myMin

private

myMinZoom

Standard_Real DDS_DicItem::myMinZoom

private

myOptions

OptionsMap DDS_DicItem::myOptions

private

myRequired

TCollection_ExtendedString DDS_DicItem::myRequired

private

myShortDescr

TCollection_ExtendedString DDS_DicItem::myShortDescr

private

myType

Standard_Integer DDS_DicItem::myType

private

myUnitData

NCollection_DataMap<UnitSystem, UnitData> DDS_DicItem::myUnitData

private

myWarnLevel

Standard_Integer DDS_DicItem::myWarnLevel

private

myZoomOrder

Standard_Real DDS_DicItem::myZoomOrder

private

---

The documentation for this class was generated from the following files:

• src/DDS/DDS_DicItem.h
• src/DDS/DDS_DicItem.cxx