Arcane::TimeHistoryAddValueArg Class Reference

#include <arcane/core/ITimeHistoryMng.h>

Collaboration diagram for Arcane::TimeHistoryAddValueArg:

Public Member Functions
	TimeHistoryAddValueArg (const String &name, bool end_time, Integer subdomain_id)
	Constructor with three parameters.
	TimeHistoryAddValueArg (const String &name, bool end_time)
	Constructor with two parameters.
	TimeHistoryAddValueArg (const String &name)
	Constructor with one parameter.
const String &	name () const
bool	endTime () const
bool	isLocal () const
Integer	localSubDomainId () const

Private Attributes
String	m_name
bool	m_end_time
Integer	m_subdomain_id

Detailed Description

Class containing the arguments for the user methods 'addValue'.

Definition at line 33 of file ITimeHistoryMng.h.

Constructor & Destructor Documentation

TimeHistoryAddValueArg() [1/3]

Arcane::TimeHistoryAddValueArg::TimeHistoryAddValueArg ( const String & name, bool end_time, Integer subdomain_id )

inline

Constructor with three parameters.

Parameters

name	The name of the curve.
end_time	Should the value be written at our iteration or at our iteration-1?
subdomain_id	The ID of the subdomain that must save the value (-1 for global).

Definition at line 44 of file ITimeHistoryMng.h.

Referenced by TimeHistoryAddValueArg(), and TimeHistoryAddValueArg().

Here is the caller graph for this function:

TimeHistoryAddValueArg() [2/3]

Arcane::TimeHistoryAddValueArg::TimeHistoryAddValueArg ( const String & name, bool end_time )

inline

Constructor with two parameters.

The value will be saved globally, and not on a specific subdomain.

Parameters

name	The name of the curve.
end_time	Should the value be written at our iteration or at our iteration-1?

Definition at line 58 of file ITimeHistoryMng.h.

References TimeHistoryAddValueArg().

Here is the call graph for this function:

TimeHistoryAddValueArg() [3/3]

Arcane::TimeHistoryAddValueArg::TimeHistoryAddValueArg ( const String & name )

inlineexplicit

Constructor with one parameter.

The value will be saved globally, and not on a specific subdomain. The value will be saved at our iteration.

Parameters

name	The name of the curve.

Definition at line 70 of file ITimeHistoryMng.h.

References TimeHistoryAddValueArg().

Here is the call graph for this function:

Member Function Documentation

endTime()

bool Arcane::TimeHistoryAddValueArg::endTime ( ) const

inline

Definition at line 77 of file ITimeHistoryMng.h.

isLocal()

bool Arcane::TimeHistoryAddValueArg::isLocal ( ) const

inline

Definition at line 78 of file ITimeHistoryMng.h.

localSubDomainId()

Integer Arcane::TimeHistoryAddValueArg::localSubDomainId ( ) const

inline

Definition at line 79 of file ITimeHistoryMng.h.

name()

const String & Arcane::TimeHistoryAddValueArg::name ( ) const

inline

Definition at line 76 of file ITimeHistoryMng.h.

Member Data Documentation

m_end_time

bool Arcane::TimeHistoryAddValueArg::m_end_time

private

Definition at line 84 of file ITimeHistoryMng.h.

m_name

String Arcane::TimeHistoryAddValueArg::m_name

private

Definition at line 83 of file ITimeHistoryMng.h.

m_subdomain_id

Integer Arcane::TimeHistoryAddValueArg::m_subdomain_id

private

Definition at line 85 of file ITimeHistoryMng.h.

---

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

• ITimeHistoryMng.h