DDS_DicItem.h File Reference

#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>

Go to the source code of this file.

Classes
class	DDS_DicItem
	This class provides an information about datum (phisical characteristic parameter). More...
struct	DDS_DicItem::UnitData

Functions
	DEFINE_STANDARD_HANDLE (DDS_DicItem, Standard_Transient) typedef NCollection_IndexedDataMap< TCollection_AsciiString
	Handle (DDS_DicItem)> DDS_IndexedDataMapOfDicItems
	Get the dictionary item with specified identifier theID. More...

Function Documentation

DEFINE_STANDARD_HANDLE()

DEFINE_STANDARD_HANDLE	(	DDS_DicItem	,
		Standard_Transient
	)

Handle()

Handle

(

DDS_DicItem

)

Get the dictionary item with specified identifier theID.

If dictionary item is not found, null handle is returned.

Parameters

theID

item identifier

Returns

dictionary item

Return all keys of the group

Parameters

seq	- string container to be filled with keys

Instantiate new dictionary item, used for customization of data dictionary items.

Returns

New dictionary item instance.

Bind dictionary item to ID

Returns

Standard_True if the item has been succesfully bound. Standard_False if there is an item with same id.

Get the dictionary item with specified identifier theID.

If the component or item is not found, null handle is returned.

Parameters

theID	data dictionary item ID
theComponent	component name

Returns

handle to the data dictionary item

Get the data dictionary item by specified identifier theID.

Function searches the item in all components. If item is not found in all components, null handle is returned.

Parameters

theID

data dictionary item ID

Returns

handle to the data dictionary item

Fill the internal data structures from the XML node.

Parameters

theDocElement

document XML node

Get the dictionary item with specified identifier theID.

Returns

handle to data dictionary item

Set the dictionary item to the datum.

Parameters

item	handle to data dictionary item

References Handle().