datadescriptiondatabase.h File Reference

Classes

class  DataDescriptionDatabaseInterface
 

Namespaces

 maxon
 

Macros

#define ENUMCOMMAND
 
#define ENUM_EXTENSION_SEPARATOR
 
#define ENUMSEPARATOR
 
#define ENUM_EXTENSION_ENUM
 
#define ENUM_EXTENSION_REMOVE
 
#define ENUMREMOVE
 
#define PRESET_EXTENSION_VARIABLE
 
#define VARIABLEID_PREFIX
 
#define DATADESCRIPTION_ID_COMMAND
 
#define DATADESCRIPTION_ID_ENUM
 
#define DATADESCRIPTION_ID_PRESET
 

Typedefs

using ProcessEnumListDelegate = Delegate< Result< void >(const Id &epId, const DataDictionary &guiEntry, const AssetRepositoryRef &repository, const Data *filterData, const ValueReceiver< Tuple< Id, Data, String > && > &addValue)>
 
using EnumVariableResolveDelegate = Delegate< Result< CString >(const CString &variable, const CString &fullString, const AssetRepositoryRef &repository, const GetDataCallbackType &getDataCallback, Opt< const DataDictionary & > dataEntry, Opt< const DataDictionary & > guiEntry)>
 

Functions

 MAXON_DATATYPE (ProcessEnumListDelegate, "net.maxon.datatype.processenumlistdelegate")
 
 MAXON_REGISTRY (ProcessEnumListDelegate, ProcessEnumListDelegates, "net.maxon.datadescription.registry.processenumlist")
 
 MAXON_DATATYPE (EnumVariableResolveDelegate, "net.maxon.datatype.delegate.enumvariableresolve")
 
 MAXON_REGISTRY (EnumVariableResolveDelegate, EnumVariableResolveDelegates, "net.maxon.datadescription.registry.enumvariableresolve")
 
Bool UseFilterData (const Data *filterData, const Data &compare)
 

Variables

const Id DATADESCRIPTION_CATEGORY_DATA
 
const Id DATADESCRIPTION_CATEGORY_UI
 
const Id DATADESCRIPTION_CATEGORY_STRING
 
static constexpr Char EXTENSION_ID_SEPARATOR
 

Macro Definition Documentation

◆ ENUMCOMMAND

#define ENUMCOMMAND

◆ ENUM_EXTENSION_SEPARATOR

#define ENUM_EXTENSION_SEPARATOR

Enumeration extension points that adds a separator in between entries.

◆ ENUMSEPARATOR

#define ENUMSEPARATOR

Deprecated.

◆ ENUM_EXTENSION_ENUM

#define ENUM_EXTENSION_ENUM

Enumeration extension points that allows reuse/important enum resources instead of copy pasting them. Supports the following format "enum#net.maxon.neutron.someenumresource"

◆ ENUM_EXTENSION_REMOVE

#define ENUM_EXTENSION_REMOVE

Prepend this tag before an enumeration Id in a GUI Enum List to filter out certain ids. Useful when enums are populated dynamically with "enum#", "registry#", "node#", ...

◆ ENUMREMOVE

#define ENUMREMOVE

Deprecated.

◆ PRESET_EXTENSION_VARIABLE

#define PRESET_EXTENSION_VARIABLE

Prefix used in identifiers such as "net.maxon.{var#somevariabletoresolve}" to identify pieces to be resolved to get the final identifier.

◆ VARIABLEID_PREFIX

#define VARIABLEID_PREFIX

Deprecated.

◆ DATADESCRIPTION_ID_COMMAND

#define DATADESCRIPTION_ID_COMMAND

Special identifier markers used in description identifiers for command, enum and presets. Identifier in JSON data could look like this: "databaseurlin#command#reload" or "splinetype#enum#net.maxon.registry.geometryabstraction.curve.types.bezier" or "alignaxis#enum#xpos" or "alignaxis#enum#ypos" It is preprended with the port identifier which needs the child entry and appended with the identifier of the command/enum/preset itself.

◆ DATADESCRIPTION_ID_ENUM

#define DATADESCRIPTION_ID_ENUM

◆ DATADESCRIPTION_ID_PRESET

#define DATADESCRIPTION_ID_PRESET