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

---

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

Classes | Public Types | 公共成员函数 | 静态公共成员函数 | 静态公共属性 | Protected Member Functions | 私有成员函数 | Static Private Member Functions | Friends | 所有成员列表

ErrorInterface Class Reference 系统

#include <objectbase.h>

Inheritance diagram for ErrorInterface:

[ legend ]

详细描述

ErrorInterface is the base interface for errors. ErrorInterface itself cannot be instantiated, but there are several derived interfaces to indicate specific error conditions such as OutOfMemoryError, NullptrError or IllegalStateError.

An error typically contains file and line information ( GetLocation() ) and a message ( GetMessage() ). It may also have a stack trace ( GetStackTrace() ) and a cause ( GetCause() ), which is another error which caused this error.

Normally, errors shouldn't be used directly for return types of functions. Instead, you should use Result<T> which can hold a result value and an error. The macros iferr and iferr_return support Result to facilitate error handling.

Errors are typically created in statements like

return IllegalStateError( MAXON_SOURCE_LOCATION , "Object already contained in hierarchy." _s);

The usage of MAXON_SOURCE_LOCATION ensures that file and line information is set correctly in the error. The message is optional, and you can also pass a cause as third argument to the constructor. Some error classes may add specific constructors with additional arguments. But errors also support method chaining if you want so set additional values like the stack trace:

To trigger a DebugStop() or CriticalStop() on creation of an error, add DbgStop() or CritStop() at the end of the creation as in

The ToString implementation of errors supports the following format statements:

• "NoStack" to suppress the output of the call stack.
• "NoLocation" to suppress the output of the code location.
• "NoCause" to suppress the output of the cause error.
• "NoMachine" to suppress the output of the machine. The machine is only printed out if it's not the local machine.
• "Class" to print error class.

另请参阅

@CLANGDUMMY errors

Public Types
using	接口 = ErrorInterface
using	IsAllocType = std::true_type
using	Ptr = maxon::ReferenceBase< ReferenceFunctions < maxon::RefBaseFunctions< maxon::DirectRef< ErrorInterface , maxon::PointerHandler , void > >> >
using	ConstPtr = maxon::ReferenceBase< ReferenceFunctions < maxon::RefBaseFunctions< maxon::DirectRef< const ErrorInterface , maxon::PointerHandler , void > >> >
Public Types inherited from ObjectInterface
using	接口 = ObjectInterface
using	IsAllocType = std::true_type
using	Ptr = maxon::ReferenceBase< ReferenceFunctions < maxon::RefBaseFunctions< maxon::DirectRef< ObjectInterface , maxon::PointerHandler , void > >> >
using	ConstPtr = maxon::ReferenceBase< ReferenceFunctions < maxon::RefBaseFunctions< maxon::DirectRef< const ObjectInterface , maxon::PointerHandler , void > >> >
using	BaseInterface = ObjectInterface

公共成员函数
Ptr	GetPtr ()
ConstPtr	GetPtr () const
	MAXON_ADD_TO_COPY_ON_WRITE_REFERENCE_CLASS (protected:void Create( MAXON_SOURCE_LOCATION_DECLARATION ) { *static_cast< typename S::DirectlyReferencedType::Hxx1::ReferenceClass * >(this)=S::DirectlyReferencedType::Hxx1::ErrObj::GetInstance()();typename S::DirectlyReferencedType::Ptr e=this->MakeWritable(false).GetPointer();e.SetLocation( MAXON_SOURCE_LOCATION_FORWARD );} void Create( MAXON_SOURCE_LOCATION_DECLARATION , const String &msg) { *static_cast< typename S::DirectlyReferencedType::Hxx1::ReferenceClass * >(this)=S::DirectlyReferencedType::Hxx1::ErrObj::GetInstance()();typename S::DirectlyReferencedType::Ptr e=this->MakeWritable(false).GetPointer();e.SetLocation( MAXON_SOURCE_LOCATION_FORWARD );e.SetMessage(msg);} void Create( MAXON_SOURCE_LOCATION_DECLARATION , const String &msg, const Error &cause) { *static_cast< typename S::DirectlyReferencedType::Hxx1::ReferenceClass * >(this)=S::DirectlyReferencedType::Hxx1::ErrObj::GetInstance()();typename S::DirectlyReferencedType::Ptr e=this->MakeWritable(false).GetPointer();e.SetLocation( MAXON_SOURCE_LOCATION_FORWARD );e.SetMessage(msg);e.SetCause(cause);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS (RefMemberType< S > DbgStop() { DebugOutput ( OUTPUT::DIAGNOSTIC , static_cast< const typename S::ReferenceClass * >(this) -> ToString ()); DebugStop ();return this->PrivateGetRefMember();} RefMemberType< S > CritStop() { CriticalOutput (static_cast< const typename S::ReferenceClass * >(this) -> ToString ());return this->PrivateGetRefMember();} RefMemberType< S > DiagOutput() { DiagnosticOutput (static_cast< const typename S::ReferenceClass * >(this) -> ToString ());return this->PrivateGetRefMember();})
const MAXON_METHOD SourceLocation &	GetLocation () const
MAXON_METHOD void	SetLocation ( MAXON_SOURCE_LOCATION_DECLARATION )
MAXON_METHOD Block < void *const >	GetStackTrace () const
MAXON_METHOD void	SetStackTrace (const Block < void *const > &trace)
MAXON_FUNCTION void	SetStackTrace ( Int skip= STACKTRACE_SKIP )
MAXON_METHOD String	GetMessage () const
MAXON_METHOD void	SetMessage (const String &message)
const MAXON_METHOD Error &	GetCause () const
MAXON_METHOD void	SetCause (const Error &cause)
MAXON_METHOD void	GetMachine (MachineRef &machine) const
MAXON_METHOD void	SetMachine (const MachineRef &machine)
MAXON_METHOD Int	PrivateGetCode () const
MAXON_METHOD void	PrivateSetCode ( Int code)
MAXON_METHOD void	PrivateSetPreallocation ( ThreadReferencedError preallocation) const
MAXON_METHOD ThreadReferencedError	PrivateGetPreallocation () const
MAXON_METHOD void	PrivateSetDebugError (const Error &cause) const
Public Member Functions inherited from ObjectInterface
Ptr	GetPtr ()
ConstPtr	GetPtr () const
template<typename INTERFACE = ObjectInterface>
const MAXON_FUNCTION maxon::Class < typename INTERFACE::Hxx1::ReferenceClass > &	GetClass () const
const MAXON_FUNCTION ClassInfo *	GetClassInfo () const
template<typename REF >
const ComponentInfo &	GetComponentInfoOfSuper (const REF *sptr, OverloadRank0 ) const MAXON_IF_TARGET_DEBUG (
template<typename REF , typename = typename REF::Component::ComponentClass>
const ComponentInfo &	GetComponentInfoOfSuper (const REF *sptr, OverloadRank1 ) const
MAXON_FUNCTION Bool	HasSameClass (const ObjectInterface *obj) const
Result < void >	CopyFrom (const ObjectInterface * src )
Result < ObjectInterface * >	Clone () const
template<typename REFCLASS >
MAXON_FUNCTION Result < REFCLASS >	Clone () const
template<typename I >
MAXON_FUNCTION Bool	IsInstanceOf () const
MAXON_FUNCTION Bool	IsInstanceOf (const DataType &type) const
MAXON_METHOD String	ToString (const FormatStatement *formatStatement=nullptr) const
MAXON_METHOD Result < void >	InitObject (const void *argument)
MAXON_METHOD Result < void >	HandleMessage (const InternedId &message, const void *argument)
MAXON_METHOD Bool	IsEqual (const maxon::ObjectInterface *other) const
MAXON_METHOD COMPARERESULT	比较 (const maxon::ObjectInterface *other) const
MAXON_FUNCTION HashInt	GetHashCode () const
MAXON_METHOD HashInt	GetHashCodeImpl () const
MAXON_METHOD HashValue	GetHashValueImpl () const
	MAXON_ADD_TO_CONST_REFERENCE_CLASS ( Bool operator==(std::nullptr_t) const { return RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), nullptr);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS ( Bool operator!=(std::nullptr_t) const { return ! RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), nullptr);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS ( Bool operator==(const ObjectInterface *ref) const { return RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), ref);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS ( Bool operator!=(const ObjectInterface *ref) const { return ! RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), ref);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS ( Bool operator==( ObjectInterface *ref) const { return RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), ref);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS ( Bool operator!=( ObjectInterface *ref) const { return ! RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), ref);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS (template< typename T > Bool operator==(T *ref) const { return RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), ref);})
	MAXON_ADD_TO_CONST_REFERENCE_CLASS (template< typename T > Bool operator!=(T *ref) const { return ! RefCompare < MAXON_IS_COW_KIND (S::Handler::KIND), true >::template IsEqual < const ObjectInterface *, const ObjectInterface * >(this->GetPointer(), ref);})
Bool	PrivateIsInstanceOf (const DataType &type) const

静态公共成员函数
static maxon::Id	GetInterfaceId ()
static ErrorInterface *	Alloc ( MAXON_SOURCE_LOCATION_DECLARATION , const ErrorInterface & src )
template<typename DUMMY >
static maxon::Int	PrivateInstantiateNullValueHelper ()
static maxon::InterfaceReference *	PrivateGetInterface ()
Static Public Member Functions inherited from ObjectInterface
static maxon::Id	GetInterfaceId ()
static ObjectInterface *	Alloc ( MAXON_SOURCE_LOCATION_DECLARATION , const ObjectInterface & src )
template<typename DUMMY >
static maxon::Int	PrivateInstantiateNullValueHelper ()
static maxon::InterfaceReference *	PrivateGetInterface ()
static std::nullptr_t	NullValuePtr ()
static void	PrivateFreeInstance ( ObjectInterface *o)

静态公共属性
static maxon::InterfaceReference	_interface
static maxon::NonvirtualInterfaceReference	_staticInterface
static const maxon::EntityBase::FLAGS	REFERENCE_KIND
Static Public Attributes inherited from ObjectInterface
static maxon::InterfaceReference	_interface
static maxon::NonvirtualInterfaceReference	_staticInterface
static const maxon::EntityBase::FLAGS	REFERENCE_KIND
static const EntityBase::FLAGS	INTERFACE_FLAGS

Protected Member Functions
	~ ErrorInterface ()
Protected Member Functions inherited from ObjectInterface
	~ ObjectInterface ()
void	RemoveReference () const

Additional Inherited Members
Public Attributes inherited from ObjectInterface
maxon::ObjectInterface::ReferenceFunctions	MAXON_ENUM_LIST_CLASS

Member Typedef Documentation

◆  接口

◆  IsAllocType

◆  Ptr

◆  ConstPtr

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

◆  ~ ErrorInterface()

◆  ErrorInterface() [1/2]

◆  ErrorInterface() [2/2]

成员函数文档编制

◆  GetInterfaceId()

◆  Alloc() [1/2]

◆  GetPtr() [1/2]

◆  GetPtr() [2/2]

◆  PrivateInstantiateNullValueHelper()

◆  PrivateGetInterface()

◆  Alloc() [2/2]

◆  GetInfoOffset()

◆  operator=()

◆  PrivateCheckClass()

◆  MAXON_ADD_TO_COPY_ON_WRITE_REFERENCE_CLASS()

◆  MAXON_ADD_TO_CONST_REFERENCE_CLASS()

◆  GetLocation()

Returns the file location where the error was created.

返回

Location (file and line) of the error creation.

◆  SetLocation()

Sets the file location where the error was created.

参数

[in]

allocLocation

Location (file and line) of the error creation.

@MAXON_ANNOTATION{returnsThis,noResult}

◆  GetStackTrace()

Returns the stack trace of this error. This may be empty.

返回

Error stack trace.

◆  SetStackTrace() [1/2]

Sets the stack trace of this error.

参数

[in]

trace

Error stack trace to use for this error.

@MAXON_ANNOTATION{returnsThis,noResult}

◆  SetStackTrace() [2/2]

Sets the stack trace of this error to the current stack trace. The skip parameter allows to skip the topmost stack frames, which are typically insignificant as they include the SetStackTrace invocation itself.

参数

[in]

skip

Number of stack frames to skip. A reasonable value may depend on the compiler and its settings and also on the context (e.g., whether the compiler inlined functions at the specific call site or not).

@MAXON_ANNOTATION{returnsThis,noResult}

◆  GetMessage()

Returns the message of this error.

返回

Error message.

◆  SetMessage()

Sets the message of this error.

参数

[in]

message

Error message to use for this error.

@MAXON_ANNOTATION{returnsThis,noResult}

◆  GetCause()

Returns the cause of this error. A cause is itself an error of which the current error is a subsequent error.

返回

Cause of this error, this will be a null reference in most cases.

◆  SetCause()

Sets the cause of this error. A cause is itself an error of which the current error is a subsequent error.

参数

[in]

cause

Cause to use for this error.

@MAXON_ANNOTATION{returnsThis,noResult}

◆  GetMachine()

Returns the machine that caused this error.

参数

[out]

machine

Receives the machine that caused this error.

◆  SetMachine()

Sets the machine that caused this error.

参数

[in]

machine

机器 that caused this error.

◆  PrivateGetCode()

◆  PrivateSetCode()

@MAXON_ANNOTATION{returnsThis,noResult}

◆  PrivateSetPreallocation()

◆  PrivateGetPreallocation()

◆  PrivateSetDebugError()

Friends And Related Function Documentation

◆  maxon::ClassInterface

◆  maxon::ComponentDescriptor

◆  maxon::StrongCOWRefHandler

Member Data Documentation

◆  _interface

◆  _staticInterface

◆  REFERENCE_KIND

• maxon
• ErrorInterface