Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
ArcaneSimpleCsvOutputObject Class Reference

Generation de la classe de base du Service. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/build/arcane/std/SimpleCsvOutput_axl.h>

Inheritance diagram for ArcaneSimpleCsvOutputObject:
Collaboration diagram for ArcaneSimpleCsvOutputObject:

Public Member Functions

 ArcaneSimpleCsvOutputObject (const Arcane::ServiceBuildInfo &sbi)
 Constructeur.
virtual ~ArcaneSimpleCsvOutputObject ()
 Destructeur.
CaseOptionsSimpleCsvOutputoptions () const
 Options du jeu de données du service.
Public Member Functions inherited from Arcane::BasicService
 ~BasicService () override
 Releases resources.
virtual ISubDomainsubDomain ()
Public Member Functions inherited from Arcane::AbstractService
 ~AbstractService () override
 Destructor.
virtual void build ()
 Build-level construction of the service.
IServiceInfoserviceInfo () const override
 Access to service information. See IServiceInfo for details.
IBaseserviceParent () const override
 Access to the base interface of main Arcane objects.
IServiceserviceInterface () override
 Returns the low-level IService interface of the service.
Public Member Functions inherited from Arcane::TraceAccessor
 TraceAccessor (ITraceMng *m)
 Constructs an accessor via the trace manager m.
 TraceAccessor (const TraceAccessor &rhs)
 Copy constructor.
TraceAccessoroperator= (const TraceAccessor &rhs)
 Copy assignment operator.
virtual ~TraceAccessor ()
 Frees resources.
ITraceMngtraceMng () const
 Trace manager.
TraceMessage info () const
 Flow for an information message.
TraceMessage pinfo () const
 Flow for a parallel information message.
TraceMessage info (char category) const
 Flow for an information message of a given category.
TraceMessage pinfo (char category) const
 Flow for a parallel information message of a given category.
TraceMessage info (bool v) const
 Flow for an information message.
TraceMessage warning () const
 Flow for a warning message.
TraceMessage pwarning () const
TraceMessage error () const
 Flow for an error message.
TraceMessage perror () const
TraceMessage log () const
 Flow for a log message.
TraceMessage plog () const
 Flow for a log message.
TraceMessage logdate () const
 Flow for a log message preceded by the date.
TraceMessage fatal () const
 Flow for a fatal error message.
TraceMessage pfatal () const
 Flow for a parallel fatal error message.
TraceMessageDbg debug (Trace::eDebugLevel=Trace::Medium) const
 Flow for a debug message.
Trace::eDebugLevel configDbgLevel () const
 Debug level of the configuration file.
TraceMessage info (Int32 verbose_level) const
 Flow for an information message of a given level.
TraceMessage linfo () const
 Flow for an information message with the local information level of this instance.
TraceMessage linfo (Int32 relative_level) const
 Flow for an information message with the local information level of this instance.
void fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::IService
virtual ~IService ()
 Releases resources.
Public Member Functions inherited from Arcane::MeshAccessor
 MeshAccessor (ISubDomain *sd)
 MeshAccessor (IMesh *mesh)
 MeshAccessor (const MeshHandle &mesh_handle)
Integer nbCell () const
 Returns the number of cells in the mesh.
Integer nbFace () const
 Returns the number of faces in the mesh.
Integer nbEdge () const
 Returns the number of edges in the mesh.
Integer nbNode () const
 Returns the number of nodes in the mesh.
VariableNodeReal3nodesCoordinates () const
 Returns the coordinates of the mesh nodes.
NodeGroup allNodes () const
 Returns the group containing all nodes.
EdgeGroup allEdges () const
 Returns the group containing all edges.
FaceGroup allFaces () const
 Returns the group containing all faces.
CellGroup allCells () const
 Returns the group containing all cells.
FaceGroup outerFaces () const
 Returns the group containing all boundary faces.
NodeGroup ownNodes () const
 Returns the group containing all nodes specific to this domain.
CellGroup ownCells () const
 Returns the group containing all cells specific to this domain.
FaceGroup ownFaces () const
 Group containing all faces specific to this domain.
EdgeGroup ownEdges () const
 Group containing all edges specific to this domain.
IMeshmesh () const
const MeshHandlemeshHandle () const
Public Member Functions inherited from Arcane::CommonVariables
 CommonVariables (IModule *c)
 Constructs the references of the common variables for the module c.
 CommonVariables (IVariableMng *variable_mng)
 Constructs the references of the common variables for the manager variable_mng.
 CommonVariables (ISubDomain *sd)
 Constructs the references of the common variables for the subdomain sd.
virtual ~CommonVariables ()
 Releases resources.
Int32 globalIteration () const
 Current iteration number.
Real globalTime () const
 Current time.
Real globalOldTime () const
 Previous current time.
Real globalFinalTime () const
 Final time of the simulation.
Real globalDeltaT () const
 Current Delta T.
Real globalCPUTime () const
 CPU time used (in seconds).
Real globalOldCPUTime () const
 Previous CPU time used (in seconds).
Real globalElapsedTime () const
 Clock time (elapsed) used (in seconds).
Real globalOldElapsedTime () const
 Previous clock time (elapsed) used (in seconds).
Public Member Functions inherited from Arcane::ISimpleTableOutput
virtual bool init ()=0
 Method to initialize the table.
virtual bool init (const String &table_name)=0
 Method to initialize the table.
virtual bool init (const String &table_name, const String &directory_name)=0
 Method to initialize the table.
virtual void clear ()=0
 Method to clear the tables.
virtual Integer addRow (const String &row_name)=0
 Method to add a row.
virtual Integer addRow (const String &row_name, ConstArrayView< Real > elements)=0
 Method to add a row.
virtual bool addRows (StringConstArrayView rows_names)=0
 Method to add multiple rows.
virtual Integer addColumn (const String &column_name)=0
 Method to add a column.
virtual Integer addColumn (const String &column_name, ConstArrayView< Real > elements)=0
 Method to add a column.
virtual bool addColumns (StringConstArrayView columns_names)=0
 Method to add multiple columns.
virtual bool addElementInRow (Integer position, Real element)=0
 Method to add an element to a row.
virtual bool addElementInRow (const String &row_name, Real element, bool create_if_not_exist=true)=0
 Method to add an element to a row.
virtual bool addElementInSameRow (Real element)=0
 Method to add an element to the last manipulated row.
virtual bool addElementsInRow (Integer position, ConstArrayView< Real > elements)=0
 Method to add multiple elements to a row.
virtual bool addElementsInRow (const String &row_name, ConstArrayView< Real > elements, bool create_if_not_exist=true)=0
 Method to add multiple elements to a row.
virtual bool addElementsInSameRow (ConstArrayView< Real > elements)=0
 Method to add multiple elements to the last manipulated row.
virtual bool addElementInColumn (Integer position, Real element)=0
 Method to add an element to a column.
virtual bool addElementInColumn (const String &column_name, Real element, bool create_if_not_exist=true)=0
 Method to add an element to a column.
virtual bool addElementInSameColumn (Real element)=0
 Method to add an element to the last manipulated column.
virtual bool addElementsInColumn (Integer position, ConstArrayView< Real > elements)=0
 Method to add multiple elements to a column.
virtual bool addElementsInColumn (const String &column_name, ConstArrayView< Real > elements, bool create_if_not_exist=true)=0
 Method to add multiple elements to a column.
virtual bool addElementsInSameColumn (ConstArrayView< Real > elements)=0
 Method to add multiple elements to the last manipulated column.
virtual bool editElementUp (Real element, bool update_last_position=true)=0
 Method to edit an element above the last element manipulated (row above/same column).
virtual bool editElementDown (Real element, bool update_last_position=true)=0
 Method to edit an element below the last element manipulated (row below/same column).
virtual bool editElementLeft (Real element, bool update_last_position=true)=0
 Method to edit an element to the left of the last element manipulated (same row/column to the left).
virtual bool editElementRight (Real element, bool update_last_position=true)=0
 Method to edit an element to the right of the last element manipulated (same row/column to the right).
virtual Real elementUp (bool update_last_position=false)=0
 Method to retrieve an element above the last element manipulated (row above/same column).
virtual Real elementDown (bool update_last_position=false)=0
 Method to retrieve an element below the last element manipulated (row below/same column).
virtual Real elementLeft (bool update_last_position=false)=0
 Method to retrieve an element to the left of the last element manipulated (same row/column to the left).
virtual Real elementRight (bool update_last_position=false)=0
 Method to retrieve an element to the right of the last element manipulated (same row/column to the right).
virtual bool editElement (Real element)=0
 Method to modify an element in the table.
virtual bool editElement (Integer position_x, Integer position_y, Real element)=0
 Method to modify an element in the table.
virtual bool editElement (const String &column_name, const String &row_name, Real element)=0
 Method allowing modification of an element in the array.
virtual Real element ()=0
 Method allowing retrieval of a copy of an element.
virtual Real element (Integer position_x, Integer position_y, bool update_last_position=false)=0
 Method allowing retrieval of a copy of an element.
virtual Real element (const String &column_name, const String &row_name, bool update_last_position=false)=0
 Method allowing retrieval of a copy of an element.
virtual RealUniqueArray row (Integer position)=0
 Method allowing retrieval of a copy of a row.
virtual RealUniqueArray row (const String &row_name)=0
 Method allowing retrieval of a copy of a row.
virtual RealUniqueArray column (Integer position)=0
 Method allowing retrieval of a copy of a column.
virtual RealUniqueArray column (const String &column_name)=0
 Method allowing retrieval of a copy of a column.
virtual Integer rowSize (Integer position)=0
 Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.
virtual Integer rowSize (const String &row_name)=0
 Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.
virtual Integer columnSize (Integer position)=0
 Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.
virtual Integer columnSize (const String &column_name)=0
 Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.
virtual Integer rowPosition (const String &row_name)=0
 Method allowing retrieval of the position of a row.
virtual Integer columnPosition (const String &column_name)=0
 Method allowing retrieval of the position of a column.
virtual Integer numberOfRows ()=0
 Method allowing retrieval of the number of rows in the array. This is, in a way, the maximum number of elements a column can contain.
virtual Integer numberOfColumns ()=0
 Method allowing retrieval of the number of columns in the array. This is, in a way, the maximum number of elements a row can contain.
virtual String rowName (Integer position)=0
virtual String columnName (Integer position)=0
virtual bool editRowName (Integer position, const String &new_name)=0
 Method allowing changing the name of a row.
virtual bool editRowName (const String &row_name, const String &new_name)=0
 Method allowing changing the name of a row.
virtual bool editColumnName (Integer position, const String &new_name)=0
 Method allowing changing the name of a column.
virtual bool editColumnName (const String &column_name, const String &new_name)=0
 Method allowing changing the name of a column.
virtual Integer addAverageColumn (const String &column_name)=0
 Method allowing creation of a column containing the average of the elements of each row.
virtual void print (Integer rank=0)=0
 Method allowing display of the array. Method performing collective operations.
virtual bool writeFile (const Directory &root_directory, Integer rank)=0
virtual bool writeFile (Integer rank=-1)=0
 Method allowing writing the array to a file. Method performing collective operations. If rank != -1, processes other than P0 return true.
virtual bool writeFile (const String &directory, Integer rank=-1)=0
 Method allowing writing the array to a file. Method performing collective operations. If rank != -1, processes other than P0 return true.
virtual Integer precision ()=0
 Method allowing retrieval of the precision currently used for writing values.
virtual void setPrecision (Integer precision)=0
 Method allowing modification of the print precision.
virtual bool isFixed ()=0
 Method allowing knowledge of whether the 'std::fixed' flag is active or not for writing values.
virtual void setFixed (bool fixed)=0
 Method allowing setting the 'std::fixed' flag or not.
virtual bool isForcedToUseScientificNotation ()=0
 Method allowing knowledge of whether the 'std::scientific' flag is active or not for writing values.
virtual void setForcedToUseScientificNotation (bool use_scientific)=0
 Method allowing setting the 'std::scientific' flag or not.
virtual String outputDirectory ()=0
 Accessor allowing retrieval of the name of the directory where the arrays will be placed.
virtual void setOutputDirectory (const String &directory)=0
 Accessor allowing definition of the directory in which the arrays will be saved.
virtual String tableName ()=0
 Accessor allowing retrieval of the name of the arrays.
virtual void setTableName (const String &name)=0
 Accessor allowing definition of the array name.
virtual String fileName ()=0
 Accessor allowing retrieval of the file name.
virtual Directory outputPath ()=0
 Accessor allowing retrieval of the path where the arrays will be saved.
virtual Directory rootPath ()=0
 Accessor allowing retrieval of the path where the implementation saves these arrays.
virtual bool isOneFileByRanksPermited ()=0
 Method allowing knowledge of whether the parameters currently held by the implementation allow it to write one file per process.
virtual String fileType ()=0
 Method allowing knowledge of the service's file type.
virtual Ref< SimpleTableInternalinternal ()=0
 Method allowing retrieval of a reference to the SimpleTableInternal object used.
virtual Ref< ISimpleTableReaderWriterreaderWriter ()=0
 Method allowing retrieval of a reference to the ISimpleTableReaderWriter object used.

Static Public Member Functions

template<typename ServiceClassType>
static void fillServiceInfo (Arcane::ServiceInfo *si)

Static Private Member Functions

static Arcane::FileContent getAxlContent ()
 Variables du service.

Private Attributes

CaseOptionsSimpleCsvOutputm_options
 Options du jeu de données du service.

Additional Inherited Members

Public Attributes inherited from Arcane::CommonVariables
VariableScalarInt32 m_global_iteration
 Current iteration.
VariableScalarReal m_global_time
 Current time.
VariableScalarReal m_global_deltat
 Global Delta T.
VariableScalarReal m_global_old_time
 Time previous to the current time.
VariableScalarReal m_global_old_deltat
 Delta T at the time previous to the global time.
VariableScalarReal m_global_final_time
 Final time of the case.
VariableScalarReal m_global_old_cpu_time
 Previous CPU time used (in seconds).
VariableScalarReal m_global_cpu_time
 CPU time used (in seconds).
VariableScalarReal m_global_old_elapsed_time
 Previous clock time used (in seconds).
VariableScalarReal m_global_elapsed_time
 Clock time used (in seconds).
Protected Member Functions inherited from Arcane::BasicService
 BasicService (const ServiceBuildInfo &)
Protected Member Functions inherited from Arcane::AbstractService
 AbstractService (const ServiceBuildInfo &)
 Constructor from a ServiceBuildInfo.
Protected Member Functions inherited from Arcane::TraceAccessor
void _setLocalVerboseLevel (Int32 v)
Int32 _localVerboseLevel () const
Protected Member Functions inherited from Arcane::IService
 IService ()
 Constructor.

Detailed Description

Generation de la classe de base du Service.

Definition at line 164 of file SimpleCsvOutput_axl.h.

Constructor & Destructor Documentation

◆ ArcaneSimpleCsvOutputObject()

ArcaneSimpleCsvOutputObject::ArcaneSimpleCsvOutputObject ( const Arcane::ServiceBuildInfo & sbi)
inline

Constructeur.

Definition at line 184 of file SimpleCsvOutput_axl.h.

References Arcane::ServiceBuildInfoBase::caseOptions(), and m_options.

Here is the call graph for this function:

◆ ~ArcaneSimpleCsvOutputObject()

virtual ArcaneSimpleCsvOutputObject::~ArcaneSimpleCsvOutputObject ( )
inlinevirtual

Destructeur.

Definition at line 196 of file SimpleCsvOutput_axl.h.

References m_options.

Member Function Documentation

◆ fillServiceInfo()

template<typename ServiceClassType>
void ArcaneSimpleCsvOutputObject::fillServiceInfo ( Arcane::ServiceInfo * si)
inlinestatic

Definition at line 170 of file SimpleCsvOutput_axl.h.

◆ getAxlContent()

Arcane::FileContent ArcaneSimpleCsvOutputObject::getAxlContent ( )
inlinestaticprivate

Variables du service.

Definition at line 216 of file SimpleCsvOutput_axl.h.

◆ options()

CaseOptionsSimpleCsvOutput * ArcaneSimpleCsvOutputObject::options ( ) const
inline

Options du jeu de données du service.

Definition at line 205 of file SimpleCsvOutput_axl.h.

References m_options.

Referenced by Arcane::SimpleCsvOutputService::init(), and Arcane::SimpleCsvOutputService::init().

Here is the caller graph for this function:

Member Data Documentation

◆ m_options

CaseOptionsSimpleCsvOutput* ArcaneSimpleCsvOutputObject::m_options
private

Options du jeu de données du service.

Definition at line 210 of file SimpleCsvOutput_axl.h.

Referenced by ArcaneSimpleCsvOutputObject(), options(), and ~ArcaneSimpleCsvOutputObject().


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