Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::EntryPoint Class Reference

Public Member Functions

 ~EntryPoint () override
 Frees resources.
String name () const override
 Returns the name of the entry point.
String fullName () const override
 Full name (with the module) of the entry point. This name is unique.
ISubDomainsubDomain () const override
 Returns the main manager.
IModulemodule () const override
 Returns the module associated with the entry point.
void executeEntryPoint () override
 Calls the entry point.
Real totalCPUTime () const override
 Total CPU consumption spent in this entry point (in milliseconds).
Real lastCPUTime () const override
 CPU consumption of the last iteration (in milliseconds).
Real totalElapsedTime () const override
 Elapsed execution time (clock time) in this entry point (in milliseconds).
Real lastElapsedTime () const override
 Elapsed execution time (clock time) of the last iteration (in milliseconds).
Real totalTime (Timer::eTimerType type) const override
 Returns totalElapsedTime().
Real lastTime (Timer::eTimerType type) const override
 Returns lastElapsedTime().
Integer nbCall () const override
 Returns the number of times the entry point has been executed.
String where () const override
 Returns where the entry point is called.
int property () const override
 Returns the properties of the entry point.
 EntryPoint (const EntryPoint &)=delete
void operator= (const EntryPoint &)=delete
virtual ~IEntryPoint ()=default
 Releases resources.

Static Public Member Functions

static EntryPoint * create (const EntryPointBuildInfo &bi)
 Constructs and returns an entry point.

Additional Inherited Members

Public Types inherited from Arcane::IEntryPoint
enum  { PNone = 0 , PAutoLoadBegin = 1 , PAutoLoadEnd = 2 }
 Properties of an entry point. More...
static const char *const WComputeLoop = "ComputeLoop"
 called during the calculation loop
static const char *const WBuild = "Build"
 called for module construction
static const char *const WInit = "Init"
 called during initialization
static const char *const WContinueInit = "ContinueInit"
 called during continuation initialization
static const char *const WStartInit = "StartInit"
 called during new case initialization
static const char *const WRestore = "Restore"
 called to restore variables during a rollback
static const char *const WOnMeshChanged = "OnMeshChanged"
 called after a mesh change
static const char *const WOnMeshRefinement = "OnMeshRefinement"
 called after mesh refinement
static const char *const WExit = "Exit"

Detailed Description

Definition at line 95 of file EntryPoint.h.

Constructor & Destructor Documentation

◆ ~EntryPoint()

Arcane::EntryPoint::~EntryPoint ( )
override

Frees resources.

Definition at line 87 of file EntryPoint.cc.

Member Function Documentation

◆ create()

EntryPoint * Arcane::EntryPoint::create ( const EntryPointBuildInfo & bi)
static

Constructs and returns an entry point.

The entry point is constructed with the information provided by \bi. It is automatically added to the IEntryPointMng manager and should not be explicitly destroyed.

Definition at line 77 of file EntryPoint.cc.

Referenced by Arcane::addEntryPoint(), and Arcane::addEntryPoint().

◆ executeEntryPoint()

void Arcane::EntryPoint::executeEntryPoint ( )
overridevirtual

Calls the entry point.

Implements Arcane::IEntryPoint.

Definition at line 121 of file EntryPoint.cc.

References Arcane::platform::hasDotNETRuntime(), and Arcane::IEntryPoint::WComputeLoop.

◆ fullName()

String Arcane::EntryPoint::fullName ( ) const
inlineoverridevirtual

Full name (with the module) of the entry point. This name is unique.

Implements Arcane::IEntryPoint.

Definition at line 117 of file EntryPoint.h.

◆ lastCPUTime()

Real Arcane::EntryPoint::lastCPUTime ( ) const
overridevirtual

CPU consumption of the last iteration (in milliseconds).

Note
since version 3.6 of Arcane, this method returns the same value as lastElapsedTime().

Implements Arcane::IEntryPoint.

Definition at line 155 of file EntryPoint.cc.

◆ lastElapsedTime()

Real Arcane::EntryPoint::lastElapsedTime ( ) const
overridevirtual

Elapsed execution time (clock time) of the last iteration (in milliseconds).

Implements Arcane::IEntryPoint.

Definition at line 173 of file EntryPoint.cc.

Referenced by lastTime().

◆ lastTime()

Real Arcane::EntryPoint::lastTime ( Timer::eTimerType ) const
overridevirtual

Returns lastElapsedTime().

Deprecated
Use lastElapsedTime() instead

Implements Arcane::IEntryPoint.

Definition at line 200 of file EntryPoint.cc.

References lastElapsedTime().

◆ module()

IModule * Arcane::EntryPoint::module ( ) const
inlineoverridevirtual

Returns the module associated with the entry point.

Implements Arcane::IEntryPoint.

Definition at line 119 of file EntryPoint.h.

◆ name()

String Arcane::EntryPoint::name ( ) const
inlineoverridevirtual

Returns the name of the entry point.

Implements Arcane::IEntryPoint.

Definition at line 116 of file EntryPoint.h.

◆ nbCall()

Integer Arcane::EntryPoint::nbCall ( ) const
inlineoverridevirtual

Returns the number of times the entry point has been executed.

Implements Arcane::IEntryPoint.

Definition at line 127 of file EntryPoint.h.

◆ property()

int Arcane::EntryPoint::property ( ) const
inlineoverridevirtual

Returns the properties of the entry point.

Implements Arcane::IEntryPoint.

Definition at line 129 of file EntryPoint.h.

◆ subDomain()

ISubDomain * Arcane::EntryPoint::subDomain ( ) const
inlineoverridevirtual

Returns the main manager.

Implements Arcane::IEntryPoint.

Definition at line 118 of file EntryPoint.h.

◆ totalCPUTime()

Real Arcane::EntryPoint::totalCPUTime ( ) const
overridevirtual

Total CPU consumption spent in this entry point (in milliseconds).

Note
since version 3.6 of Arcane, this method returns the same value as totalElapsedTime().

Implements Arcane::IEntryPoint.

Definition at line 164 of file EntryPoint.cc.

◆ totalElapsedTime()

Real Arcane::EntryPoint::totalElapsedTime ( ) const
overridevirtual

Elapsed execution time (clock time) in this entry point (in milliseconds).

Implements Arcane::IEntryPoint.

Definition at line 182 of file EntryPoint.cc.

Referenced by totalTime().

◆ totalTime()

Real Arcane::EntryPoint::totalTime ( Timer::eTimerType ) const
overridevirtual

Returns totalElapsedTime().

Deprecated
Use totalElapsedTime() instead

Implements Arcane::IEntryPoint.

Definition at line 191 of file EntryPoint.cc.

References totalElapsedTime().

◆ where()

String Arcane::EntryPoint::where ( ) const
inlineoverridevirtual

Returns where the entry point is called.

Implements Arcane::IEntryPoint.

Definition at line 128 of file EntryPoint.h.


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