maxon.LazyLanguageStringDataDescriptionDefinitionInterface

Description

Interface to manage lazy loading of maxon.LanguageStringDataDescriptionDefinition for description strings.

Inheritance diagram

Inheritance

Parent Class:

Child Class:

Methods Signature

Get(languageId)

Returns the description of the given language.

GetMetaData()

Returns all descriptions to export.

LoadAll()

Loads all string resources from the meta data into memory (e.g.

NullValuePtr(*args)

Helper function to return the default value for an empty cow object.

Set(languageId, description)

Stores the description for the given language.

SetMetaData(meta, path)

Sets the asset from which the definition shall be loaded lazily.

Methods Definition

LazyLanguageStringDataDescriptionDefinitionInterface.Get(languageId)

Returns the description of the given language.

Parameters

languageId (maxon.Id) – Id of the language to load.

Returns

maxon.DataDescriptionDefinition on success.

Return type

maxon.DataDescriptionDefinition

LazyLanguageStringDataDescriptionDefinitionInterface.GetMetaData()

Returns all descriptions to export.

Returns

maxon.LanguageStringDataDescriptionDefinition on success.

Return type

maxon.LanguageStringDataDescriptionDefinition

LazyLanguageStringDataDescriptionDefinitionInterface.LoadAll()

Loads all string resources from the meta data into memory (e.g. for copying data).

static LazyLanguageStringDataDescriptionDefinitionInterface.NullValuePtr(*args)

Helper function to return the default value for an empty cow object.

Returns

An empty maxon.LazyLanguageStringDataDescriptionDefinition.

Return type

maxon.LazyLanguageStringDataDescriptionDefinition

LazyLanguageStringDataDescriptionDefinitionInterface.Set(languageId, description)

Stores the description for the given language.

Parameters
  • languageId (maxon.Id) – Id of the language to load.

  • description (maxon.DataDescriptionDefinition) – Description to store.

LazyLanguageStringDataDescriptionDefinitionInterface.SetMetaData(meta, path)

Sets the asset from which the definition shall be loaded lazily.

Parameters
  • meta (maxon.AssetMetaData) – Asset meta data to use for loading the strings.

  • path (str) – Relative path of the description within the asset.