Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::EntryPointBuildInfo Class Reference

Information to build an entry point. More...

#include <arcane/core/EntryPoint.h>

Collaboration diagram for Arcane::EntryPointBuildInfo:

Public Member Functions

 EntryPointBuildInfo (IModule *module, const String &name, IFunctor *caller, const String &where, int property, bool is_destroy_caller)
 Entry point build information.
IModulemodule () const
const Stringname () const
IFunctorcaller () const
const Stringwhere () const
int property () const
bool isDestroyCaller () const

Private Attributes

IModulem_module
String m_name
IFunctorm_caller
String m_where
int m_property
bool m_is_destroy_caller

Detailed Description

Information to build an entry point.

Normally this class is not used directly. To build an entry point, you must use addEntryPoint().

Definition at line 37 of file EntryPoint.h.

Constructor & Destructor Documentation

◆ EntryPointBuildInfo()

Arcane::EntryPointBuildInfo::EntryPointBuildInfo ( IModule * module,
const String & name,
IFunctor * caller,
const String & where,
int property,
bool is_destroy_caller )
inline

Entry point build information.

Parameters
modulemodule associated with the function
wherelocation in the time loop where the entry point is called
propertyproperties of the entry point (see IEntryPoint)
namename of the entry point
callerencapsulation of the method to be called.
is_destroy_callerindicates whether the entry point should destroy the functor caller.

Generally, is_destroy_caller must be true, otherwise the memory will not be released. Note that the C# wrapping handles the functor via a garbage collector, so in this case is_destroy_caller must be false.

Definition at line 57 of file EntryPoint.h.

Member Function Documentation

◆ caller()

IFunctor * Arcane::EntryPointBuildInfo::caller ( ) const
inline

Definition at line 73 of file EntryPoint.h.

◆ isDestroyCaller()

bool Arcane::EntryPointBuildInfo::isDestroyCaller ( ) const
inline

Definition at line 76 of file EntryPoint.h.

◆ module()

IModule * Arcane::EntryPointBuildInfo::module ( ) const
inline

Definition at line 71 of file EntryPoint.h.

◆ name()

const String & Arcane::EntryPointBuildInfo::name ( ) const
inline

Definition at line 72 of file EntryPoint.h.

◆ property()

int Arcane::EntryPointBuildInfo::property ( ) const
inline

Definition at line 75 of file EntryPoint.h.

◆ where()

const String & Arcane::EntryPointBuildInfo::where ( ) const
inline

Definition at line 74 of file EntryPoint.h.

Member Data Documentation

◆ m_caller

IFunctor* Arcane::EntryPointBuildInfo::m_caller
private

Definition at line 82 of file EntryPoint.h.

◆ m_is_destroy_caller

bool Arcane::EntryPointBuildInfo::m_is_destroy_caller
private

Definition at line 85 of file EntryPoint.h.

◆ m_module

IModule* Arcane::EntryPointBuildInfo::m_module
private

Definition at line 80 of file EntryPoint.h.

◆ m_name

String Arcane::EntryPointBuildInfo::m_name
private

Definition at line 81 of file EntryPoint.h.

◆ m_property

int Arcane::EntryPointBuildInfo::m_property
private

Definition at line 84 of file EntryPoint.h.

◆ m_where

String Arcane::EntryPointBuildInfo::m_where
private

Definition at line 83 of file EntryPoint.h.


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