就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. C4D R23.110 C++ SDK
公共成员函数 | 所有成员列表

DefaultDoc Class Reference

#include <defaultdoc.h>

详细描述

The only purpose of this class is to be used in @copydoc commands for standard functions like CopyFrom or GetHashCode. For example to add a default documentation to a CopyFrom function of a class, write

Result<void> CopyFrom ( const MyClass& src );

公共成员函数

  DefaultDoc ()=default
Result < void >  CopyFrom (const DefaultDoc & src )
void  重置 ()
HashInt   GetHashCode () const
Bool   operator== (const DefaultDoc &other) const
Bool   operator!= (const DefaultDoc &other) const
Bool   operator< (const DefaultDoc &other) const
Bool   operator<= (const DefaultDoc &other) const
Bool   operator> (const DefaultDoc &other) const
Bool   operator>= (const DefaultDoc &other) const
COMPARERESULT   比较 (const DefaultDoc &other) const
String   ToString (const FormatStatement *formatStatement=nullptr) const

构造函数 & 析构函数文档编制

◆  DefaultDoc()

DefaultDoc ( )
default

Constructs a @CLASS object with default values.

成员函数文档编制

◆  CopyFrom()

Result <void> CopyFrom ( const DefaultDoc &  src )

Makes this @CLASS a copy of src by copying the contents of src into this @CLASS.

参数
[in] src Another @CLASS to be used as source for the copy operation.
返回
OK on success.

◆  Reset()

void Reset ( )

Resets this @CLASS to the state it has right after default construction. This includes freeing all resources held by this @CLASS.

◆  GetHashCode()

HashInt GetHashCode ( ) const

Returns the hash code of this @CLASS.

返回
Hash code of this @CLASS.

◆  operator==()

Bool operator== ( const DefaultDoc &  other ) const

Checks if this @CLASS equals #other.

参数
[in] other Another @CLASS.
返回
True if this equals #other, false otherwise.

◆  operator!=()

Bool operator!= ( const DefaultDoc &  other ) const

Checks if this @CLASS is not equal to #other.

参数
[in] other Another @CLASS.
返回
True if this is not equal to #other, false otherwise.

◆  operator<()

Bool operator< ( const DefaultDoc &  other ) const

Checks if this @CLASS is less than #other.

参数
[in] other Another @CLASS.
返回
True if this is less than #other, false otherwise.

◆  operator<=()

Bool operator<= ( const DefaultDoc &  other ) const

Checks if this @CLASS is less than or equal to #other.

参数
[in] other Another @CLASS.
返回
True if this is less than or equal to #other, false otherwise.

◆  operator>()

Bool operator> ( const DefaultDoc &  other ) const

Checks if this @CLASS is greater than #other.

参数
[in] other Another @CLASS.
返回
True if this is greater than #other, false otherwise.

◆  operator>=()

Bool operator>= ( const DefaultDoc &  other ) const

Checks if this @CLASS is greater than or equal to #other.

参数
[in] other Another @CLASS.
返回
True if this is greater than or equal to #other, false otherwise.

◆  Compare()

COMPARERESULT 比较 ( const DefaultDoc &  other ) const

Compares this and #other.

参数
[in] other Another @CLASS.
返回
Result of the comparison.

◆  ToString()

String ToString ( const FormatStatement *  formatStatement = nullptr ) const

Returns a String representation of this @CLASS.

参数
[in] formatStatement Nullptr or additional formatting instruction.
返回
String representation of this @CLASS.
maxon::DefaultDoc::CopyFrom
Result< void > CopyFrom(const DefaultDoc &src)
maxon::src
const T & src
定义： apibase.h:2525