DDS_Dictionary.h File Reference

#include "DDS_DicGroup.h"
#include <LDOMString.hxx>
#include <MMgt_TShared.hxx>

Go to the source code of this file.

Functions
DEFINE_STANDARD_HANDLE(DDS_Dictionary, MMgt_TShared) class DDS_Dictionary Standard_EXPORT void	GetKeys (const TCollection_AsciiString &, TColStd_SequenceOfAsciiString &) const
	Fill given string container seq with keys belonging to group with name theComponent. More...
Standard_EXPORT	Handle (DDS_DicItem) GetDicItem(const TCollection_AsciiString &) const
Standard_EXPORT void	GetUnitSystems (TColStd_SequenceOfAsciiString &) const
Standard_EXPORT void	GetUnitSystems (TColStd_SequenceOfAsciiString &, const TCollection_AsciiString &) const
	Get the names of defined units systems from the specified component theComponent. More...
Standard_EXPORT TCollection_ExtendedString	GetUnitSystemLabel (const TCollection_AsciiString &) const
Standard_EXPORT TCollection_ExtendedString	GetUnitSystemLabel (const TCollection_AsciiString &, const TCollection_AsciiString &) const
	Get the label of the units system theSystem from the component theComponent. More...
Standard_EXPORT TCollection_AsciiString	GetActiveUnitSystem () const
Standard_EXPORT TCollection_AsciiString	GetActiveUnitSystem (const TCollection_AsciiString &) const
Standard_EXPORT void	SetActiveUnitSystem (const TCollection_AsciiString &)
Standard_EXPORT void	SetActiveUnitSystem (const TCollection_AsciiString &, const TCollection_AsciiString &)
	Set the active units system for the component theComponent. More...
static Standard_EXPORT Standard_Boolean	Load (const TCollection_AsciiString)
static Standard_EXPORT Standard_Real	ToSI (const Standard_Real, const Standard_CString)
static Standard_EXPORT Standard_Real	FromSI (const Standard_Real, const Standard_CString)
static Standard_EXPORT LDOMString	KeyWord (const TCollection_AsciiString &)
	Get XML keyword as LDOMString by specified key. More...
virtual Standard_EXPORT	Handle (DDS_DicGroup) CreateGroup(const TCollection_AsciiString &) const
Standard_EXPORT	DDS_Dictionary ()
Standard_EXPORT	DDS_Dictionary (const DDS_Dictionary &)
	Copy constructor (put in private section to prevent object copying). More...
Standard_EXPORT void	operator= (const DDS_Dictionary &)
virtual Standard_EXPORT void	FillDataMap (const LDOM_Element &)
static Standard_EXPORT void	SetDictionary (const Handle(DDS_Dictionary)&theDict)
static	Handle (DDS_Dictionary) myDictionary
	Get the only instance of the data dictionary. More...
	OCCT_DEFINE_STANDARD_RTTIEXT (DDS_Dictionary, MMgt_TShared)}

Variables
Standard_EXPORT const TCollection_AsciiString &	const
DDS_IndexedDataMapOfDicGroups	myGroupMap

Function Documentation

Standard_EXPORT DDS_Dictionary ( )

protected

DDS_Dictionary::DDS_Dictionary ( const DDS_Dictionary &  )

protected

virtual Standard_EXPORT void FillDataMap ( const LDOM_Element &  )

protectedvirtual

static Standard_EXPORT Standard_Real FromSI ( const Standard_Real  , const Standard_CString    )

static

Standard_EXPORT TCollection_AsciiString GetActiveUnitSystem

(

)

const

Standard_EXPORT TCollection_AsciiString GetActiveUnitSystem

(

const TCollection_AsciiString &

)

const

void DDS_Dictionary::GetKeys	(	const TCollection_AsciiString &	theComponent,
		TColStd_SequenceOfAsciiString &	seq
	)		const

Parameters

theComponent	name of group whose keys should be stored in the container
seq	returned string container with keys belonging to group; it is not cleared before filling

References Handle(), and myGroupMap.

Standard_EXPORT TCollection_ExtendedString GetUnitSystemLabel

(

const TCollection_AsciiString &

)

const

TCollection_ExtendedString DDS_Dictionary::GetUnitSystemLabel	(	const TCollection_AsciiString &	theSystem,
		const TCollection_AsciiString &	theComponent
	)		const

Searches the specified units system in the specified component only. If units system is not found, empty string is returned.

Parameters

theSystem	units system
theComponent	component name

Returns

units system label

References myGroupMap.

Standard_EXPORT void GetUnitSystems

(

TColStd_SequenceOfAsciiString &

)

const

void DDS_Dictionary::GetUnitSystems	(	TColStd_SequenceOfAsciiString &	theSystems,
		const TCollection_AsciiString &	theComponent
	)		const

If component is not found, empty list is returned.

Parameters

theSystems	returning sequence of units systems names.
theComponent	component name

References myGroupMap.

Standard_EXPORT Handle

(

DDS_DicItem

)

const

virtual Standard_EXPORT Handle ( DDS_DicGroup  ) const

protectedvirtual

static Handle ( DDS_Dictionary  )

staticprivate

Returns

the only instance of the data dictionary

References DDS_Dictionary.

LDOMString DDS_Dictionary::KeyWord ( const TCollection_AsciiString &  key )

static

If key doesn't exist, empty string is returned. This function is provided for convenience.

Parameters

key	keyword name

Returns

keyword value

References Handle().

static Standard_EXPORT Standard_Boolean Load ( const TCollection_AsciiString  )

static

OCCT_DEFINE_STANDARD_RTTIEXT	(	DDS_Dictionary	,
		MMgt_TShared
	)

Standard_EXPORT void operator= ( const DDS_Dictionary &  )

protected

Standard_EXPORT void SetActiveUnitSystem

(

const TCollection_AsciiString &

)

void DDS_Dictionary::SetActiveUnitSystem	(	const TCollection_AsciiString &	theSystem,
		const TCollection_AsciiString &	theComponent
	)

If specified units system doesn't exist in the component, nothing happens.

Parameters

theSystem	units system to be made active
theComponent	component name

References myGroupMap.

static Standard_EXPORT void SetDictionary ( const Handle(DDS_Dictionary)&  theDict )

staticprotected

static Standard_EXPORT Standard_Real ToSI ( const Standard_Real  , const Standard_CString    )

static

Variable Documentation

Standard_EXPORT const TCollection_AsciiString& const

DDS_IndexedDataMapOfDicGroups myGroupMap