Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence de l'espace de nommage Arccore::Platform

Espace de nom pour les fonctions dépendant de la plateforme. Plus de détails...

Fonctions

ARCCORE_BASE_EXPORT bool isDirectoryExist (const String &dir_name, bool &can_create)
 
ARCCORE_BASE_EXPORT void platformInitialize ()
 Initialisations spécifiques à une platforme.
 
ARCCORE_BASE_EXPORT void platformInitialize (bool enable_fpe)
 Initialisations spécifiques à une platforme.
 
ARCCORE_BASE_EXPORT void platformTerminate ()
 Routines de fin de programme spécifiques à une platforme.
 
ARCCORE_BASE_EXPORT String getCurrentDate ()
 Date courante.
 
ARCCORE_BASE_EXPORT long getCurrentTime ()
 Date courante.
 
ARCCORE_BASE_EXPORT String getCurrentDateTime ()
 Date et l'heure courante sous la forme ISO 8601.
 
ARCCORE_BASE_EXPORT String getHostName ()
 Nom de la machine sur lequel tourne le processus.
 
ARCCORE_BASE_EXPORT String getCurrentDirectory ()
 Chemin du répertoire courant.
 
ARCCORE_BASE_EXPORT int getProcessId ()
 Numéro du processus.
 
ARCCORE_BASE_EXPORT String getUserName ()
 Nom de l'utilisateur.
 
ARCCORE_BASE_EXPORT String getHomeDirectory ()
 Répertoire contenant les documents utilisateurs.
 
ARCCORE_BASE_EXPORT long unsigned int getFileLength (const String &filename)
 Longueur du fichier filename. Si le fichier n'est pas lisible ou n'existe pas, retourne 0.
 
ARCCORE_BASE_EXPORT String getEnvironmentVariable (const String &name)
 Variable d'environnement du nom name.
 
ARCCORE_BASE_EXPORT bool recursiveCreateDirectory (const String &dir_name)
 Créé un répertoire.
 
ARCCORE_BASE_EXPORT bool createDirectory (const String &dir_name)
 Créé le répertoire.
 
ARCCORE_BASE_EXPORT bool removeFile (const String &file_name)
 Supprime le fichier file_name.
 
ARCCORE_BASE_EXPORT bool isFileReadable (const String &file_name)
 Vérifie que le fichier file_name est accessible et lisible.
 
ARCCORE_BASE_EXPORT String getFileDirName (const String &file_name)
 Retourne le nom du répertoire d'un fichier.
 
ARCCORE_BASE_EXPORT void stdMemcpy (void *to, const void *from,::size_t len)
 Copie de zone mémoire.
 
ARCCORE_BASE_EXPORT double getMemoryUsed ()
 Mémoire utilisée em octets.
 
ARCCORE_BASE_EXPORT Int64 getCPUTime ()
 Temps CPU utilisé en microsecondes.
 
ARCCORE_BASE_EXPORT Real getRealTime ()
 Temps Real utilisé en secondes.
 
ARCCORE_BASE_EXPORT String timeToHourMinuteSecond (Real t)
 Retourne un temps sous forme des heures, minutes et secondes.
 
ARCCORE_BASE_EXPORT bool isDenormalized (Real v)
 Retourne true si v est dénormalisé (flottant invalide).
 
ARCCORE_BASE_EXPORT IStackTraceServicegetStackTraceService ()
 Service utilisé pour obtenir la pile d'appel.
 
ARCCORE_BASE_EXPORT IStackTraceServicesetStackTraceService (IStackTraceService *service)
 Positionne le service utilisé pour obtenir la pile d'appel.
 
ARCCORE_BASE_EXPORT String getStackTrace ()
 Retourne une chaîne de caractere contenant la pile d'appel.
 
ARCCORE_BASE_EXPORT void safeStringCopy (char *output, Integer output_len, const char *input)
 
ARCCORE_BASE_EXPORT void sleep (Integer nb_second)
 Met le process en sommeil pendant nb_second secondes.
 
ARCCORE_BASE_EXPORT void enableFloatingException (bool active)
 Active ou désactive les exceptions lors d'un calcul flottant. Cette opération n'est pas supportée sur toutes les plateformes. Dans le cas où elle n'est pas supportée, rien ne se passe.
 
ARCCORE_BASE_EXPORT bool isFloatingExceptionEnabled ()
 Indique si les exceptions flottantes du processeur sont activées.
 
ARCCORE_BASE_EXPORT void raiseFloatingException ()
 Lève une exception flottante.
 
ARCCORE_BASE_EXPORT bool hasFloatingExceptionSupport ()
 Indique si l'implémentation permet de modifier l'état d'activation des exceptions flottantes.
 
ARCCORE_BASE_EXPORT void dumpStackTrace (std::ostream &ostr)
 Affiche la pile d'appel sur le flot ostr.
 
ARCCORE_BASE_EXPORT bool getConsoleHasColor ()
 Indique si la console supporte les couleurs.
 
ARCCORE_BASE_EXPORT String getCompilerId ()
 Chaîne de caractère permettant d'identifier le compilateur utilisé pour compiler Arccore.
 

Variables

IStackTraceServiceglobal_stack_trace_service = nullptr
 
bool global_has_color_console = false
 

Description détaillée

Espace de nom pour les fonctions dépendant de la plateforme.

Cet espace de nom contient toutes les fonctions dépendant de la plateforme.

Documentation des fonctions

◆ createDirectory()

ARCCORE_BASE_EXPORT bool Arccore::Platform::createDirectory ( const String dir_name)

Créé le répertoire.

Créé un répertoire de nom dir_name. Cette fonction suppose que le répertoire parent existe déjà.

Valeurs retournées
trueen cas d'échec,
falseen cas de succès ou si le répertoire existe déjà.

Définition à la ligne 320 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::localstr().

◆ dumpStackTrace()

ARCCORE_BASE_EXPORT void Arccore::Platform::dumpStackTrace ( std::ostream &  ostr)

Affiche la pile d'appel sur le flot ostr.

Définition à la ligne 627 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références getStackTraceService(), Arccore::IStackTraceService::stackTrace(), et Arccore::StackTrace::toString().

◆ enableFloatingException()

ARCCORE_BASE_EXPORT void Arccore::Platform::enableFloatingException ( bool  active)

Active ou désactive les exceptions lors d'un calcul flottant. Cette opération n'est pas supportée sur toutes les plateformes. Dans le cas où elle n'est pas supportée, rien ne se passe.

Définition à la ligne 655 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par platformInitialize().

◆ getCompilerId()

String Arccore::Platform::getCompilerId ( )

Chaîne de caractère permettant d'identifier le compilateur utilisé pour compiler Arccore.

Définition à la ligne 777 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::StringBuilder::toString().

◆ getConsoleHasColor()

bool Arccore::Platform::getConsoleHasColor ( )

Indique si la console supporte les couleurs.

Définition à la ligne 767 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getCPUTime()

ARCCORE_BASE_EXPORT Int64 Arccore::Platform::getCPUTime ( )

Temps CPU utilisé en microsecondes.

L'origine du temps CPU est pris lors de l'appel à platformInitialize().

Renvoie
le temps CPU utilisé en microsecondes.

Définition à la ligne 535 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par platformInitialize().

◆ getCurrentDate()

ARCCORE_BASE_EXPORT String Arccore::Platform::getCurrentDate ( )

Date courante.

La chaîne est retournée sous la forme jour/mois/année.

Définition à la ligne 94 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getCurrentDateTime()

ARCCORE_BASE_EXPORT String Arccore::Platform::getCurrentDateTime ( )

Date et l'heure courante sous la forme ISO 8601.

La chaîne est retournée sous la forme AAAA-MM-JJTHH:MM:SS.

Définition à la ligne 122 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getCurrentDirectory()

ARCCORE_BASE_EXPORT String Arccore::Platform::getCurrentDirectory ( )

Chemin du répertoire courant.

Définition à la ligne 213 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getCurrentTime()

ARCCORE_BASE_EXPORT long Arccore::Platform::getCurrentTime ( )

Date courante.

Retourne la date courante, exprimée en secondes écoulées depuis le 1er janvier 1970.

Définition à la ligne 111 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getEnvironmentVariable()

ARCCORE_BASE_EXPORT String Arccore::Platform::getEnvironmentVariable ( const String name)

Variable d'environnement du nom name.

Si aucune variable de nom name n'est définie, la chaîne nulle est retournée.

Définition à la ligne 250 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::localstr().

Référencé par getHomeDirectory(), Arccore::MessagePassing::Mpi::MpiAdapter::MpiAdapter(), et platformInitialize().

◆ getFileDirName()

ARCCORE_BASE_EXPORT String Arccore::Platform::getFileDirName ( const String file_name)

Retourne le nom du répertoire d'un fichier.

Retourne le nom du répertoire dans lequel se trouve le fichier de nom file_name. Par exemple, si file_name vaut "/tmp/toto.cc", retourne "/tmp". Si le fichier ne contient pas de répertoires, retourne ".".

Définition à la ligne 346 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::length(), et Arccore::String::localstr().

◆ getFileLength()

ARCCORE_BASE_EXPORT long unsigned int Arccore::Platform::getFileLength ( const String filename)

Longueur du fichier filename. Si le fichier n'est pas lisible ou n'existe pas, retourne 0.

Définition à la ligne 237 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::localstr().

◆ getHomeDirectory()

ARCCORE_BASE_EXPORT String Arccore::Platform::getHomeDirectory ( )

Répertoire contenant les documents utilisateurs.

Cela correspond à la variable d'environnement HOME sur Unix, ou le répertoire 'Mes documents' sous Win32.

Définition à la ligne 184 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références getEnvironmentVariable(), et Arccore::String::null().

◆ getHostName()

ARCCORE_BASE_EXPORT String Arccore::Platform::getHostName ( )

Nom de la machine sur lequel tourne le processus.

Définition à la ligne 140 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par Arccore::arccoreDebugPause().

◆ getMemoryUsed()

ARCCORE_BASE_EXPORT double Arccore::Platform::getMemoryUsed ( )

Mémoire utilisée em octets.

Renvoie
la mémoire utilisée ou un nombre négatif si inconnu

Définition à la ligne 517 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getProcessId()

ARCCORE_BASE_EXPORT int Arccore::Platform::getProcessId ( )

Numéro du processus.

Définition à la ligne 228 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par Arccore::arccoreDebugPause().

◆ getRealTime()

ARCCORE_BASE_EXPORT Real Arccore::Platform::getRealTime ( )

Temps Real utilisé en secondes.

Renvoie
le temps utilisé en seconde.

Définition à la ligne 572 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ getStackTrace()

ARCCORE_BASE_EXPORT String Arccore::Platform::getStackTrace ( )

Retourne une chaîne de caractere contenant la pile d'appel.

Si aucun service de gestion de pile d'appel n'est présent (getStackTraceService()==0), la chaîne retournée est nulle.

Définition à la ligne 443 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références getStackTraceService(), Arccore::IStackTraceService::stackTrace(), et Arccore::StackTrace::toString().

◆ getStackTraceService()

ARCCORE_BASE_EXPORT IStackTraceService * Arccore::Platform::getStackTraceService ( )

Service utilisé pour obtenir la pile d'appel.

Peut retourner nul si aucun service n'est disponible.

Définition à la ligne 423 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par dumpStackTrace(), et getStackTrace().

◆ getUserName()

ARCCORE_BASE_EXPORT String Arccore::Platform::getUserName ( )

Nom de l'utilisateur.

Définition à la ligne 160 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ hasFloatingExceptionSupport()

ARCCORE_BASE_EXPORT bool Arccore::Platform::hasFloatingExceptionSupport ( )

Indique si l'implémentation permet de modifier l'état d'activation des exceptions flottantes.

Si cette méthode retourne false, alors les méthodes enableFloatingException() et isFloatingExceptionEnabled() sont sans effet.

Définition à la ligne 645 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ isDenormalized()

ARCCORE_BASE_EXPORT bool Arccore::Platform::isDenormalized ( Real  v)

Retourne true si v est dénormalisé (flottant invalide).

Si la plate-forme ne supporte pas cette notion, retourne toujours false.

Définition à la ligne 413 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ isDirectoryExist()

ARCCORE_BASE_EXPORT bool Arccore::Platform::isDirectoryExist ( const String dir_name,
bool &  can_create 
)

Définition à la ligne 265 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ isFileReadable()

ARCCORE_BASE_EXPORT bool Arccore::Platform::isFileReadable ( const String file_name)

Vérifie que le fichier file_name est accessible et lisible.

Valeurs retournées
truesi le fichier est lisible,
falsesinon.

Définition à la ligne 392 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::localstr().

◆ isFloatingExceptionEnabled()

ARCCORE_BASE_EXPORT bool Arccore::Platform::isFloatingExceptionEnabled ( )

Indique si les exceptions flottantes du processeur sont activées.

Définition à la ligne 672 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ platformInitialize() [1/2]

void Arccore::Platform::platformInitialize ( )

Initialisations spécifiques à une platforme.

Cette routine est appelé lors de l'initialisation de l'architecture. Elle permet d'effectuer certains traitements qui dépendent de la plateforme.

Active les exceptions flottantes i elles sont disponibles.

Définition à la ligne 750 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par Arcane::platform::platformInitialize().

◆ platformInitialize() [2/2]

void Arccore::Platform::platformInitialize ( bool  enable_fpe)

Initialisations spécifiques à une platforme.

Cette routine est appelé lors de l'initialisation de l'architecture. Elle permet d'effectuer certains traitements qui dépendent de la plateforme.

Si enable_fpe est vrai, les exceptions flottantes sont activées si elles sont disponibles (via l'appel à enableFloatingException().

Définition à la ligne 727 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références enableFloatingException(), getCPUTime(), et getEnvironmentVariable().

◆ platformTerminate()

ARCCORE_BASE_EXPORT void Arccore::Platform::platformTerminate ( )

Routines de fin de programme spécifiques à une platforme.

Cette routine est appelé juste avant de quitter le programme.

Définition à la ligne 759 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Référencé par Arcane::platform::platformTerminate().

◆ raiseFloatingException()

ARCCORE_BASE_EXPORT void Arccore::Platform::raiseFloatingException ( )

Lève une exception flottante.

Cette méthode ne fait rien si hasFloatingExceptionSupport()==false. En général sous Linux, cela se traduit par l'envoie d'un signal de type SIGFPE. Par défaut Arccore récupère ce signal et lève une exception de type 'ArithmeticException'.

Définition à la ligne 685 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ recursiveCreateDirectory()

ARCCORE_BASE_EXPORT bool Arccore::Platform::recursiveCreateDirectory ( const String dir_name)

Créé un répertoire.

Créé le répertoire de nom dir_name. Si nécessaire, créé les répertoires parents nécessaires.

Valeurs retournées
trueen cas d'échec,
falseen cas de succès ou si le répertoire existe déjà.

Définition à la ligne 285 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::length(), Arccore::String::localstr(), et recursiveCreateDirectory().

Référencé par recursiveCreateDirectory().

◆ removeFile()

ARCCORE_BASE_EXPORT bool Arccore::Platform::removeFile ( const String file_name)

Supprime le fichier file_name.

Valeurs retournées
trueen cas d'échec,
falseen cas de succès ou si le fichier n'existe pas.

Définition à la ligne 379 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::String::localstr().

Référencé par Arccore::TraceMng::finishInitialize().

◆ safeStringCopy()

ARCCORE_BASE_EXPORT void Arccore::Platform::safeStringCopy ( char *  output,
Integer  output_len,
const char *  input 
)

Définition à la ligne 457 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ setStackTraceService()

ARCCORE_BASE_EXPORT IStackTraceService * Arccore::Platform::setStackTraceService ( IStackTraceService service)

Positionne le service utilisé pour obtenir la pile d'appel.

Retourne l'ancien service utilisé.

Définition à la ligne 432 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ sleep()

ARCCORE_BASE_EXPORT void Arccore::Platform::sleep ( Integer  nb_second)

Met le process en sommeil pendant nb_second secondes.

Définition à la ligne 611 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ stdMemcpy()

ARCCORE_BASE_EXPORT void Arccore::Platform::stdMemcpy ( void *  to,
const void *  from,
::size_t  len 
)

Copie de zone mémoire.

Copie len octets de l'adresse from à l'adresse to.

Définition à la ligne 404 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ timeToHourMinuteSecond()

ARCCORE_BASE_EXPORT String Arccore::Platform::timeToHourMinuteSecond ( Real  t)

Retourne un temps sous forme des heures, minutes et secondes.

Converti t, exprimé en seconde, sous la forme AhBmCs avec A les heures, B les minutes et C les secondes. Par exemple, 3732 devient 1h2m12s.

Définition à la ligne 585 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

Références Arccore::StringBuilder::toString().

Documentation des variables

◆ global_has_color_console

bool Arccore::Platform::global_has_color_console = false

Définition à la ligne 88 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.

◆ global_stack_trace_service

IStackTraceService* Arccore::Platform::global_stack_trace_service = nullptr

Définition à la ligne 87 du fichier arccore/src/base/arccore/base/PlatformUtils.cc.