Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Destroy routine. More...

#include <KIM_ModelDestroy.hpp>

Public Member Functions
void	GetModelBufferPointer (void **const ptr) const
	Get the Model's buffer pointer within the Model object.

void	LogEntry (LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
	Write a log entry into the log file.

void	LogEntry (LogVerbosity const logVerbosity, std::stringstream const &message, int const lineNumber, std::string const &fileName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

std::string const &	ToString () const
	Get a string representing the internal state of the Model object.

Detailed Description

Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Destroy routine.

See also: KIM_ModelDestroy, kim_model_destroy_module::kim_model_destroy_handle_type

Since: 2.0

Definition at line 51 of file KIM_ModelDestroy.hpp.

Member Function Documentation

◆ GetModelBufferPointer()

void KIM::ModelDestroy::GetModelBufferPointer ( void **const ptr ) const

Get the Model's buffer pointer within the Model object.

The model buffer pointer may be used by the Model to associate a memory buffer with the Model object.

Parameters

[out] ptr The model buffer data pointer.

Note: ptr == NULL if the model has not previously called ModelCreate::SetModelBufferPointer or ModelDriverCreate::SetModelBufferPointer.

See also: KIM_ModelDestroy_GetModelBufferPointer, kim_model_destroy_module::kim_get_model_buffer_pointer

Since: 2.0

◆ LogEntry() [1/2]

void KIM::ModelDestroy::LogEntry	(	LogVerbosity const	logVerbosity,
		std::string const &	message,
		int const	lineNumber,
		std::string const &	fileName ) const

Write a log entry into the log file.

This results in a no-op if logVerbosity is LOG_VERBOSITY::silent or if logVerbosity is greater-than the Log object's top LogVerbosity on its stack.

Parameters

[in]	logVerbosity	The LogVerbosity level for the entry.
[in]	message	The body text of the log entry.
[in]	lineNumber	The source code file line number.
[in]	fileName	The source code file name.

See also: KIM_ModelDestroy_LogEntry, kim_model_destroy_module::kim_log_entry

Since: 2.0

◆ LogEntry() [2/2]

void KIM::ModelDestroy::LogEntry	(	LogVerbosity const	logVerbosity,
		std::stringstream const &	message,
		int const	lineNumber,
		std::string const &	fileName ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ ToString()

std::string const & KIM::ModelDestroy::ToString ( ) const

Get a string representing the internal state of the Model object.

This string is primarily meant for use as a debugging tool. The string may be quite long. It begins and ends with lines consisting only of ='s.

See also: KIM_ModelDestroy_ToString, kim_model_destroy_module::kim_to_string

Since: 2.0

The documentation for this class was generated from the following file: