就业培训     下载中心     Wiki     联络 登录   注册

---

1. 首页
2. C4D R23.110 C++ SDK

Public Types | 公共成员函数 | 私有成员函数 | 所有成员列表

DataDictionaryObjectInterface Class Reference Data Types

#include <datadictionaryobject.h>

Inheritance diagram for DataDictionaryObjectInterface:

[ legend ]

详细描述

Class to store and find any data type under any type of key.

DataDictionaryObjectRef values; values.Set(Data( "MachineName" _s), Data( Application::GetMachineInfo (). Get (MACHINEINFO::COMPUTERNAME))); values.Set(Data( Int (100)), Data( Application::GetMachineInfo (). Get (MACHINEINFO::OSVERSION))); values.Set(Data( 向量 (1, 0, 0)), Data( String::IntToString ( Application::GetMachineInfo (). Get (MACHINEINFO::NUMBEROFPROCESSORS))));

Member Typedef Documentation

◆  Iterator

◆  ConstIterator

成员函数文档编制

◆  MAXON_INTERFACE()

◆  SetData() [1/2]

Set 数据 under a specific id. the data type needs to be registered.

参数

[in]	key	Id under which the data is stored.
[in,out]	data	Move reference to the data.

返回

OK on success. @MAXON_ANNOTATION{returnsThis}

◆  SetData() [2/2]

Set 数据 under a specific id.

参数

[in]	key	Id under which the data is stored.
[in]	data	Reference to the data.

返回

OK on success. @MAXON_ANNOTATION{returnsThis}

◆  GetData()

Get data stored under a specific id.

参数

[in]

key

Id under which the data is stored.

返回

数据 as 数据 class.

◆  Contains()

Check if there is data stored under a specific key.

参数

[in]

key

Key under which the data should be stored.

返回

True if existent.

◆  EraseData()

Remove a data entry from the dictionary. This function doesn't check if the dictionary contained the key.

参数

[in]

key

Id under which the data is stored.

返回

OK on success. This function doesn't check if the dictionary contained the key.

◆  Reset()

Frees the entire dictionary. After this call the DataDictionary is empty.

◆  IsEmpty()

Checks if the dictionary is empty.

返回

True if the dictionary does not contain any elements. @MAXON_ANNOTATION{default=true}

◆  IsPopulated()

Checks if the dictionary contains anything.

返回

True if the dictionary contains any elements.

◆  Get() [1/3]

Get data stored under a specific key. If the key is not found an error will be returned. This functions offers 2 possible calls. First using an FId "dict.Get(MAXCHINEINFO::COMPUTERNAME)" or second using any type directly together with the result type "dict.Get<String>(Int32(5))". The data type needs to be registered.

参数

[in]

key

Key under which the data is stored.

返回

数据 converted to the right type on success. @MAXON_ANNOTATION{refclassParameter=REFCLASS}

◆  Get() [2/3]

Get data stored under a specific key. If the key is not found the given default value will be returned. This functions offers 2 possible calls. First using an FId "dict.Get(MAXCHINEINFO::COMPUTERNAME, String())" or second using any type directly together with the result type "dict.Get(Int32(5), String())". The data type needs to be registered.

参数

[in]	key	Key under which the data is stored.
[in]	defaultValue	Default value which should be returned if the key cannot be found.

返回

数据 converted to the right type if found in the dictionary, otherwise the default value. @MAXON_ANNOTATION{refclassParameter=REFCLASS}

◆  Get() [3/3]

Get data stored under a specific key. If the key is not found the given default value will be returned. This functions offers 2 possible calls. First using an FId "dict.Get(MAXCHINEINFO::COMPUTERNAME, String())" or second using any type directly together with the result type "dict.Get(Int32(5), String())". The data type needs to be registered.

参数

[in]	key	Key under which the data is stored.
[in]	defaultValue	Default value which should be returned if the key cannot be found.

返回

数据 converted to the right type if found in the dictionary, otherwise the default value. @MAXON_ANNOTATION{refclassParameter=REFCLASS}

◆  GetOrDefault()

Get data stored under a specific key. If the key is not found the given default value will be returned. This functions offers 2 possible calls. First using an FId "dict.Get(MAXCHINEINFO::COMPUTERNAME, String())" or second using any type directly together with the result type "dict.Get(Int32(5), String())". The data type needs to be registered.

参数

[in]

key

Key under which the data is stored.

返回

数据 converted to the right type if found in the dictionary, otherwise the default value.

◆  Set()

Set data under a specific id. this function is template to allow implicit Set calls for each data type. This functions offers 2 possible calls. First using an FId "dict.Set(MAXCHINEINFO::COMPUTERNAME, "data"_s)" or second using any type directly "dict.Set(Int32(5), "data"_s)". The data type needs to be registered.

参数

[in]	key	Key under which the data is stored.
[in]	data	数据 to be stored in the dictionary.

返回

OK on success. @MAXON_ANNOTATION{returnsThis,refclassParameter=REFCLASS}

◆  Erase()

Erase data stored under a specific key. This function doesn't check if the dictionary contained the key. This functions offers 2 possible calls. First using an FId "dict.Erase(MAXCHINEINFO::COMPUTERNAME)" or second using any type directly "dict.Erase(Int32(5))". The data type needs to be registered.

参数

[in]

key

Key under which the data is stored.

返回

OK on success. This function doesn't check if the dictionary contained the key. @MAXON_ANNOTATION{refclassParameter=REFCLASS}

◆  InitIterator()

Helper functions for iterator.

◆  Begin()

Returns the begin iterator of the DataDictionary. You can use the Iterator to run through all elements of the DataDictionary.

◆  End()

Returns the end iterator of the DataDictionary. You can use the Iterator to run through all elements of the DataDictionary.

• maxon
• DataDictionaryObjectInterface