DataDescriptionObjectInterface Class Reference

#include <datadescriptionobject.h>

Inheritance diagram for DataDescriptionObjectInterface:

Detailed Description

Interface and base implementation to allow objects to access descriptions. The base implementation automatically loads resources from the data description databases.

Public Member Functions
MAXON_METHOD Result< DataDescription >	GetObjectDescription (const Id &category, const LanguageRef &language, const DataDictionaryObjectRef &objectData) const

Static Public Member Functions
static MAXON_METHOD Result< String >	GetObjectName (const Id &classId, const LanguageRef &language)

Private Member Functions
	MAXON_INTERFACE (DataDescriptionObjectInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.datadescriptionobject")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( DataDescriptionObjectInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.interface.datadescriptionobject"    )

private

GetObjectDescription()

MAXON_METHOD Result<DataDescription> GetObjectDescription	(	const Id &	category,
		const LanguageRef &	language,
		const DataDictionaryObjectRef &	objectData
	)		const

GetObjectDescription returns the description of the object.

Parameters

[in]	category	Description category to load (DATADESCRIPTION_CATEGORY_DATA/DATADESCRIPTION_CATEGORY_UI).
[in]	language	Language (only valid for category DATADESCRIPTION_CATEGORY_STRING).
[in]	objectData	Data of the object to use for evaluation.

Returns

DataDescription on success. If the Description could not be found an empty description is returned but no error.

GetObjectName()

static MAXON_METHOD Result<String> GetObjectName ( const Id &  classId, const LanguageRef &  language  )

static

GetObjectName returns the localized name of the description (OBJECT::BASE::NAME).

Parameters

[in]	classId	Id of the class to determine.
[in]	language	Language to use. "nullptr" for current language.

Returns

String on success.