LegacyCommandDataInterface Class Reference

#include <commandbase.h>

Inheritance diagram for LegacyCommandDataInterface:

详细描述

Legacy command data interface: a data dictionary which holds one or more pointers to generic data used to store legacy data types.

公共成员函数

MAXON_METHOD Result < Generic * >  GetLegacyData ( Int index)
MAXON_METHOD Result < void >  SetLegacyData (const Generic *data, Int index)
MAXON_METHOD Int   GetLegacyDataCount () const
template<typename LEGACYDATA >
MAXON_FUNCTION Result < void >  SetLegacyData (const LEGACYDATA &data, Int index)
template<typename LEGACYDATA >
MAXON_FUNCTION Result < LEGACYDATA & >  GetLegacyData ( Int index)

私有成员函数

  MAXON_INTERFACE ( LegacyCommandDataInterface , MAXON_REFERENCE_NORMAL , "net.maxon.command.interface.legacycommanddata")

成员函数文档编制

◆  MAXON_INTERFACE()

MAXON_INTERFACE ( LegacyCommandDataInterface   ,
MAXON_REFERENCE_NORMAL   ,
"net.maxon.command.interface.legacycommanddata"   
)
private

◆  GetLegacyData() [1/2]

MAXON_METHOD Result <Generic*> GetLegacyData ( Int   index )

Returns a pointer to the legacy data at index.

参数
[in] index The data index.
返回
A pointer to the legacy data at the specified index. The memory ownership depends on the implementation.

◆  SetLegacyData() [1/2]

MAXON_METHOD Result <void> SetLegacyData ( const Generic *  data ,
Int   index  
)

Sets legacy data from a data pointer at index.

参数
[in] data The legacy data pointer. The memory ownership depends on the implementation.
[in] index The data index.
返回
OK on success at index.

◆  GetLegacyDataCount()

MAXON_METHOD Int GetLegacyDataCount ( ) const

Count of legacy data entries.

返回
Reference to the legacy data at index.

◆  SetLegacyData() [2/2]

MAXON_FUNCTION Result <void> SetLegacyData ( const LEGACYDATA &  data ,
Int   index  
)

Sets legacy data from a data reference at index.

Template Parameters
LEGACYDATA The type of legacy data.
参数
[in] data The data.
[in] index The data index. #return OK on success.

◆  GetLegacyData() [2/2]

MAXON_FUNCTION Result <LEGACYDATA&> GetLegacyData ( Int   index )

Gets a legacy data reference at index.

Template Parameters
LEGACYDATA The data type that will be returned.
参数
[in] index The data index.
返回
Reference to the legacy data at index.