Data Description Categories and Keys

Table of Contents

• About
• Categories
  • Data
  • String
  • UI
• Further Reading

About

Data descriptions are separated into three different categories:

• maxon::DATADESCRIPTION_CATEGORY_DATA: Descriptions of the data.
• maxon::DATADESCRIPTION_CATEGORY_STRING: Description of (translated) strings.
• maxon::DATADESCRIPTION_CATEGORY_UI: Description of the user interface.

The information of a data description is stored as a maxon::DataDictionary. The settings stored in these dictionaries is accessed with pre-defined resource IDs (see Resource IDs).

  // This example loads the description of the given data type and prints the attributes to the console.
 
  // data type ID
  const maxon::Id dataType { "net.maxonexample.class.descriptionElement" };
 
  // load description data
  maxon::Id category = maxon::DATADESCRIPTION_CATEGORY_DATA;
  const maxon::DataDescription descriptionData = maxon::DataDescriptionDatabaseInterface::LoadDescription(category, maxon::LanguageRef(), dataType) iferr_return;
 
  // load description string data
  category = maxon::DATADESCRIPTION_CATEGORY_STRING;
  const maxon::LanguageRef     language = maxon::Resource::GetDefaultLanguage();
  const maxon::DataDescription descriptionStrings = maxon::DataDescriptionDatabaseInterface::LoadDescription(category, language, dataType) iferr_return;
 
  // list all attributes
 
  const auto attributes = descriptionData.GetEntries() iferr_return;
 
  for (const maxon::DataDictionary& attribute : attributes)
  {
    // get attribute settings
 
    const maxon::InternedId ID = attribute.Get(maxon::DESCRIPTION::BASE::IDENTIFIER) iferr_return;
    const maxon::Id         attributeDataType = attribute.Get(maxon::DESCRIPTION::DATA::BASE::DATATYPE) iferr_return;
    const maxon::Data       defaultData = attribute.Get(maxon::DESCRIPTION::DATA::BASE::DEFAULTVALUE) iferr_return;
 
    DiagnosticOutput("Attribute \"@\" of type @. Default value: @", ID, attributeDataType, defaultData);
 
    // get localized attribute name
 
    ifnoerr (const maxon::DataDictionary attributeString = descriptionStrings.GetEntry(ID))
    {
      const maxon::String translatedString = attributeString.Get(maxon::DESCRIPTION::STRING::BASE::TRANSLATEDSTRING) iferr_return;
      DiagnosticOutput("Name: \"@\" (@)", translatedString, language.GetName());
    }
  }

Categories

Data

The resource IDs for basic data description settings are define in these namespaces:

• maxon::DESCRIPTION::BASE: Basic settings like the attribute identifier.
  • maxon::DESCRIPTION::BASE::COMMAND: Attribute type.
  • maxon::DESCRIPTION::BASE::IDENTIFIER: Attribute ID.
• maxon::DESCRIPTION::DATA::BASE: Base information like type, default value, units etc.
  • maxon::DESCRIPTION::BASE::DATATYPE
  • maxon::DESCRIPTION::BASE::CLASSIFICATION
  • maxon::DESCRIPTION::BASE::UNIT
  • maxon::DESCRIPTION::BASE::DEFAULTVALUE
  • maxon::DESCRIPTION::BASE::LIMITVALUE
  • maxon::DESCRIPTION::BASE::MINVALUE
  • maxon::DESCRIPTION::BASE::MAXVALUE
  • maxon::DESCRIPTION::BASE::INCLUDE
  • maxon::DESCRIPTION::BASE::INCLUDERENAME
  • maxon::DESCRIPTION::BASE::INCLUDEFILTER
  • maxon::DESCRIPTION::BASE::ENUM
  • maxon::DESCRIPTION::BASE::DATABASEID
  • maxon::DESCRIPTION::BASE::OVERWRITABLE
  • maxon::DESCRIPTION::BASE::COMMENT
  • maxon::DESCRIPTION::BASE::GENERATEIGNOREHEADER
  • maxon::DESCRIPTION::BASE::ISVARIADIC
  • maxon::DESCRIPTION::BASE::VARIADICCOUNT
  • maxon::DESCRIPTION::BASE::VARIADICCOMMANDS
  • maxon::DESCRIPTION::BASE::VARIADICIDS
  • maxon::DESCRIPTION::BASE::INHERITSTRING
  • maxon::DESCRIPTION::BASE::OPTIONALSTRING
  • maxon::DESCRIPTION::BASE::NAMESPACE
  • maxon::DESCRIPTION::BASE::INCLUDEDFROM
  • maxon::DESCRIPTION::BASE::ORIGIN
• maxon::DESCRIPTION::DATA::INFO: General info.
  • maxon::DESCRIPTION::DATA::INFO::CLASSIFICATION
  • maxon::DESCRIPTION::DATA::INFO::SUBCLASSIFICATION
  • maxon::DESCRIPTION::DATA::INFO::INCLUDEFILE
  • maxon::DESCRIPTION::DATA::INFO::COMMENT
  • maxon::DESCRIPTION::DATA::INFO::HIDDEN

For convenience one can use maxon::GetDefaultValueKey() to get the ID of maxon::DESCRIPTION::DATA::BASE::DEFAULTVALUE

String

String resource IDs are in defined in maxon::DESCRIPTION::STRING::BASE:

• maxon::DESCRIPTION::STRING::BASE::TRANSLATEDSTRING
• maxon::DESCRIPTION::STRING::BASE::REFERENCESTRING
• maxon::DESCRIPTION::STRING::BASE::TRANSLATEDREFERENCESTRING
• maxon::DESCRIPTION::STRING::BASE::TRANSLATEDCHILDREN
• maxon::DESCRIPTION::STRING::BASE::GOTONEXT
• maxon::DESCRIPTION::STRING::BASE::SUGGESTIONS
• maxon::DESCRIPTION::STRING::BASE::OPENEXTERNALCOMPARETOOL
• maxon::DESCRIPTION::STRING::BASE::APPROVECOMMAND

UI

UI resource IDs are in defined in these namespaces:

• maxon::DESCRIPTION::UI::BASE: Basic settings.
  • maxon::DESCRIPTION::UI::BASE::GUITYPEID
  • maxon::DESCRIPTION::UI::BASE::GROUPID
  • maxon::DESCRIPTION::UI::BASE::SHOWGROUPINPORTLIST
  • maxon::DESCRIPTION::UI::BASE::SHOW
  • maxon::DESCRIPTION::UI::BASE::ENABLE
  • maxon::DESCRIPTION::UI::BASE::PARENTFOLDERID
  • maxon::DESCRIPTION::UI::BASE::PARENTFOLDERIDDEFAULTOPEN
  • maxon::DESCRIPTION::UI::BASE::PRESETDATABASEID
  • maxon::DESCRIPTION::UI::BASE::PRESETMEMBERS
  • maxon::DESCRIPTION::UI::BASE::ENUM
  • maxon::DESCRIPTION::UI::BASE::ISLINKEDPORT
  • maxon::DESCRIPTION::UI::BASE::OPTIONALCHILDRENSTRINGS
  • maxon::DESCRIPTION::UI::BASE::COMMANDTYPE
  • maxon::DESCRIPTION::UI::BASE::COMMANDCONTEXT
  • maxon::DESCRIPTION::UI::BASE::MULTILINETITLE
  • maxon::DESCRIPTION::UI::BASE::GROUPDEFAULTOPEN
  • maxon::DESCRIPTION::UI::BASE::UIDEFAULTOPEN
  • maxon::DESCRIPTION::UI::BASE::GROUPTITLEBAR
  • maxon::DESCRIPTION::UI::BASE::GROUPCOLUMNS
  • maxon::DESCRIPTION::UI::BASE::HIDEWHENINLINE
• maxon::DESCRIPTION::UI::INFO
  • maxon::DESCRIPTION::UI::INFO::MENUCATEGORY
  • maxon::DESCRIPTION::UI::INFO::DEFAULTNAME
• maxon::DESCRIPTION::UI::NET::MAXON::UI
  • maxon::DESCRIPTION::UI::NET::MAXON::UI::DATA
  • maxon::DESCRIPTION::UI::NET::MAXON::UI::NUMBER
    • maxon::DESCRIPTION::UI::NET::MAXON::UI::NUMBER::SLIDER
  • maxon::DESCRIPTION::UI::NET::MAXON::UI::STRING
    • maxon::DESCRIPTION::UI::NET::MAXON::UI::STRING::MULTILINE
    • maxon::DESCRIPTION::UI::NET::MAXON::UI::STRING::READONLY
  • maxon::DESCRIPTION::UI::NET::MAXON::UI::URL
    • maxon::DESCRIPTION::UI::NET::MAXON::UI::URL::SAVEMODE
  • maxon::DESCRIPTION::UI::NET::MAXON::UI::VARIADICPORT
    • maxon::DESCRIPTION::UI::NET::MAXON::UI::VARIADICPORT::COMPLEXCUSTOMUI

Further Reading

• Data Descriptions
• DataDescriptionDefinition Manual
• DataDescription Manual
• DataDescriptionObjectInterface Manual
• DataDictionary Manual
• Resource IDs