Version: 9.12.0
DDS_KeyWords Class Reference

This class defines the pairs of internal keys and XML tags or attributes names. More...

#include <DDS_KeyWords.h>

Inheritance diagram for DDS_KeyWords:
Inheritance graph

Public Member Functions

Standard_EXPORT TCollection_AsciiString GetKeyWord (const TCollection_AsciiString &) const
 Get the XML keyword by specified internal key key. More...
 
Standard_EXPORT void SetKeyWord (const TCollection_AsciiString &, const TCollection_AsciiString &)
 Register the pair of the internal key key and XML keyword keyWord. More...
 

Static Public Member Functions

static Standard_EXPORT Handle (DDS_KeyWords) Get()
 

Private Types

typedef NCollection_DataMap< TCollection_AsciiString, TCollection_AsciiString > KeyWordMap
 

Private Member Functions

 DDS_KeyWords ()
 

Private Attributes

KeyWordMap myKeyWord
 

Detailed Description

This class defines the pairs of internal keys and XML tags or attributes names.

This class allows user to define a set of XML keywords used in the datums definition (XML) file.

Default keywords table:

  • D_URI - dictionary
  • COMPONENT - component
  • COMPONENT_NAME - name
  • UNIT_SYSTEMS - unitSystems
  • UNIT_SYSTEM - system
  • UNIT_SYSTEM_NAME - name
  • UNIT_SYSTEM_LABEL - label
  • DATUM - datum
  • DATUM_ID - id
  • DATUM_LABEL - label
  • DATUM_UNITS - units
  • DATUM_FORMAT - format
  • DATUM_FILTER - filter
  • DATUM_REQUIRED - required
  • VALUE_LIST - valueList
  • VALUE_LIST_ID - listid
  • VALUE_LIST_NAME - name
  • VALUE_LIST_TYPE - type
  • VALUE_LIST_VALUE - value
  • VALUE_LIST_VALUEID - id
  • VALUE_LIST_VALUEICON - icon
  • DY_DOMAIN - domain
  • WARNING_LEVEL - warningLevel
  • WRONG_VALUE - wrongValue
  • VALUE_DESCR - valueDescr
  • VALUE_LIST_REF - listRef
  • DESCR - description
  • LONG_D - longDescr
  • SHORT_D - shortDescr
  • VD_TYPE - type
  • VD_DEFV - default
  • VD_MAXV - max
  • VD_MINV - min
  • VD_SPEC - specVal
  • VLR_LIST - list
  • PRS - presentation
  • LATERAL_ZOOM - lateralZoom
  • LZ_MINV - min
  • LZ_MAXV - max
  • LZ_ORDER - order
  • OPTIONS - options
  • OPTION - option
  • OPTION_NAME - name

There is the only instance of the class DDS_KeyWords in the application which can be retrieved by method Get().

Member Typedef Documentation

◆ KeyWordMap

typedef NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString> DDS_KeyWords::KeyWordMap
private

Constructor & Destructor Documentation

◆ DDS_KeyWords()

DDS_KeyWords::DDS_KeyWords ( )
private

Member Function Documentation

◆ GetKeyWord()

TCollection_AsciiString DDS_KeyWords::GetKeyWord ( const TCollection_AsciiString &  key) const

Get the XML keyword by specified internal key key.

If the internal key is not registered, empty string is returned.

Parameters
keyinternal key
Returns
XML keyword

References myKeyWord.

◆ Handle()

static Standard_EXPORT DDS_KeyWords::Handle ( DDS_KeyWords  )
static

◆ SetKeyWord()

void DDS_KeyWords::SetKeyWord ( const TCollection_AsciiString &  key,
const TCollection_AsciiString &  keyWord 
)

Register the pair of the internal key key and XML keyword keyWord.

Parameters
keyinternal key
keyWordXML keyword

References myKeyWord.

Member Data Documentation

◆ myKeyWord

KeyWordMap DDS_KeyWords::myKeyWord
private

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