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

---

◆  MEMORYOBSERVERMODE

◆  SPECIALBEHAVIOR

成员函数文档编制

◆  MAXON_INTERFACE_NONVIRTUAL()

◆  MAXON_ENUM_LIST_CLASS() [1/2]

◆  MAXON_ENUM_LIST_CLASS() [2/2]

◆  MAXON_ENUM_FLAGS_CLASS()

◆  _ConsoleOutput()

Prints debug information into the console window.

参数

[in]

s

Char* to print out.

◆  GetConsoleOutputType()

Retrieves which types of output shall be supported.

返回

Diagnostic, warning and/or critical output.

◆  Alloc()

Allocates a memory block, does not clear memory (similar to malloc). The memory is not cleared, it may contain a certain byte pattern in debug mode.

参数

[in]	size	Block size in bytes (values < 0 will return nullptr).
[in]	location	MemoryAllocationStructure (filled out by a define).

返回

Memory block address or nullptr.

◆  AllocClear()

Allocates a memory block and clears it (similar to calloc).

参数

[in]	size	Block size in bytes (values < 0 will return nullptr).
[in]	location	MemoryAllocationStructure (filled out by a define).

返回

Memory block address or nullptr.

◆  Realloc()

Resizes a memory block (similar to realloc). The additional memory is not cleared, it may contain a certain byte pattern in debug mode.

参数

[in]	data	Current memory block (can be nullptr).
[in]	size	New block size in bytes (values < 0 will return nullptr).
[in]	location	MemoryAllocationStructure (filled out by a define).

返回

Memory block address or nullptr if resize is not possible (p is still valid in this case).

◆  Free()

Frees a memory block (free).

参数

[in]

data

Memory block address (can be nullptr).

◆  FreeWithDestructor()

◆  GetAllocSize()

Returns the size of a memory block.

参数

[in]

data

Memory block address (can be nullptr, but otherwise must be valid).

返回

Size of the allocated block in bytes.

◆  MemoryDiagnostics()

Returns information about memory usage and optionally prints details to the console.

参数

[in]	mode	See MEMORYDIAGNOSTICSMODE.
[out]	totalAllocation	Used to return the total amount of memory allocated including blocks being cached, used for management and so on. This might be considerably bigger than what was allocated by the application.
[out]	freePhysicalMemoryEstimate	Used to return a very rough estimate of the free physical memory (if any).

返回

Memory allocated by the application in bytes.

◆  MemoryAddObserver()

Adds an observer for low memory situations. The observer will be active until shutdown.

参数

[in]	mode	See MEMORYOBSERVERMODE.
[in]	observer	Observer.

返回

True on success.

◆  SetMemoryAllocationThreshold()

Sets the threshold value when observers of mode MEMORYOBSERVERMODE::WARNMEM_LIMIT will be executed. Calling the function again overwrites the older value.

参数

[in]

warnMemoryAllocationThreshold

The value when the observer will be executed.

◆  GetCustomTimer()

Returns the current system time which is being used by the Timer class.

返回

Seconds of the system time.

◆  GetConfigurationCount()

Returns the number of configuration values registered with ConfigurationRegister

返回

Number of configuration values.

◆  GetConfiguration()

Gets the configuration value by a given index.

参数

[in]

index

Index of the configuration value. 0 <= index < GetConfigurationCount()

返回

True on success or false if the index is out of range.

◆  ConfigurationRegister()

Registers a configuration value ConfigValues with the main application.

参数

[in]

config

The configuration value and related data (default, limits etc.).

返回

Success of the registration.

◆  GetCriticalLog()

Reads information from the critical log (which is automatically stored in memory). It contains messages that were generated calling CriticalOutput() . THREADSAFE.

参数

[in]	index	Index to the log, starting at zero. If the return value is nullptr then no more log entries exist.
[out]	count	Pointer to a value that will receive the number of log entries or nullptr.

返回

C-Style string containing the critical message or nullptr if no log entry exists for this index.

◆  GetDefinitionCount()

Returns the total number of definitions for the given entity type. This is used for statistics about the complexity of the whole application.

参数

[in]

type

Entity type. Use EntityBase::TYPE::COUNT for the total number of methods of all (virtual and non-virtual) interfaces.

返回

Number of definitions of the given type.

◆  GetVirtualInterfaceReference()

Returns the virtual references of a given class.

参数

[in]

idWithoutHash

Class ID without hash.

返回

Found interface references

◆  FindDefinition()

Returns the definition of the given entity type.

参数

[in]	type	Entity type. Use EntityBase::TYPE::COUNT for the total number of methods of all (virtual and non-virtual) interfaces.
[in]	eid	Entity id.

返回

Found EntityDefinition or nullptr if no entity was found with the given name or type.

◆  SetDebugErrorObserver()

Sets a callback which shall be invoked when an error occurs. This should be used only for debugging purposes. For example, if you want to have a DebugStop on any error during a function call, you can write:

You could even make the DebugStop() depend on the type of the error by checking the type of the error parameter.

You should clear the error callback after the code to debug by calling ResetErrorCallback().

警告

This method is not thread-safe.

参数

[in]

observer

Observer for errors.

返回

Pointer to the installed observer or nullptr on failure.

◆  ResetDebugErrorObserver()

Resets a previously set error callback.

警告

This method is not thread-safe.

另请参阅

SetErrorCallback

参数

[in]

observer

The observer to remove.

◆  SetCurrentError() [1/2]

◆  SetCurrentError() [2/2]

◆  GetLastError()

◆  SetDebugError()

◆  GetDebugError()

◆  PrivateGetInternedId()

返回

Nullptr indicates OutOfMemory.

◆  PrivateFreeInternedId()

◆  GetReferenceCounter()

Returns the reference counter for classes which do not implement custom AddReference/RemoveReference methods.

◆  GetBinaries()

◆  PrivateShowSynchronizedHashMapDiagnostics()

◆  GetPreferencesPathSuffix()

◆  GetApplicationId()

Returns the kind of application. Common definitions can be found in APPLICATIONID .

◆  SetApplicationType()

◆  FreeWithDestructorI()

参数

[in]	object	Object/memory block address (guaranteed not to be nullptr).
[in]	destruct	Object destructor (guaranteed not to be nullptr).

• maxon
• 系统