|
| template<typename T , typename... Args> |
| T & | declareUnusedValue (Args &&... args) |
| | Declare a unused value with type T.
|
| |
|
| template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args> |
| T & | declareValue (const std::string ¶m_name, Args &&... args) |
| | Method to define a value that the Reporter object is to produced.
|
| |
| template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args> |
| T & | declareValue (const std::string ¶m_name, ReporterMode mode, Args &&... args) |
| |
| template<typename T , typename S , typename... Args> |
| T & | declareValue (const std::string ¶m_name, Args &&... args) |
| |
| template<typename T , typename S , typename... Args> |
| T & | declareValue (const std::string ¶m_name, ReporterMode mode, Args &&... args) |
| |
| template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args> |
| T & | declareValueByName (const ReporterValueName &value_name, Args &&... args) |
| |
| template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args> |
| T & | declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args) |
| |
| template<typename T , typename S , typename... Args> |
| T & | declareValueByName (const ReporterValueName &value_name, Args &&... args) |
| |
| template<typename T , typename S , typename... Args> |
| T & | declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args) |
| |
Definition at line 17 of file KokkosReporter.h.
| virtual void Reporter::declareLateValues |
( |
| ) |
|
|
inlinevirtualinherited |
Method that can be overriden to declare "late" Reporter values.
Values are considered "late" when they need to be declared after all other Reporters have been instantiated. This is called by the "declare_late_reporters" task, which should be called right after the "add_reporters" task.
Reimplemented in AccumulateReporter.
Definition at line 79 of file Reporter.h.
template<typename T , typename... Args>
| T & Reporter::declareUnusedValue |
( |
Args &&... |
args | ) |
|
|
protectedinherited |
Declare a unused value with type T.
This is useful when you have a reporter that has optional values. In this case, you want to create references to all reporter values. However, because some values are optional, you need something to fill into the reference. This helper will create a unused value. It also allows for the passing of arguments in the case that your value is not trivially default constructable (constructable by default without arguments).
Definition at line 278 of file Reporter.h.
279{
280 _unused_values.emplace_back(std::make_unique<UnusedWrapper<T>>(std::forward(args)...));
281 UnusedWrapper<T> * wrapper =
dynamic_cast<UnusedWrapper<T> *
>(
_unused_values.back().get());
282 return wrapper->value;
283}
std::vector< std::unique_ptr< UnusedWrapperBase > > _unused_values
Storage for unused values declared with declareUnusedValue().
template<typename T , typename S , typename... Args>
| T & Reporter::declareValue |
( |
const std::string & |
param_name, |
|
|
Args &&... |
args |
|
) |
| |
|
protectedinherited |
Method to define a value that the Reporter object is to produced.
- Template Parameters
-
| T | The C++ type of the value to be produced |
| S | (optional) Context type for performing special operations. For example using the ReporterBroadcastContext will automatically broadcast the produced value from the root processor. |
- Parameters
-
| name | A unique name for the value to be produced. |
| mode | (optional) The mode that indicates how the value produced is represented in parallel, there is more information about this below |
| args | (optional) Any number of optional arguments passed into the ReporterContext given by the S template parameter. If S = ReporterContext then the first argument can be used as the default value (see ReporterContext.h). |
The 'mode' indicates how the value that is produced is represented in parallel. It is the responsibility of the Reporter object to get it to that state. The ReporterContext objects are designed to help with this. The mode can be one of the following:
ReporterMode::ROOT Indicates that the value produced is complete/correct on the
root processor for the object.
ReporterMode::REPLICATED Indicates that the value produced is complete/correct on
all processors AND that the value is the same on all
processors
ReporterMode::DISTRIBUTED Indicates that the value produced is complete/correct on
all processors AND that the value is NOT the same on all
processors
WARNING! Using the "default value" in ReporterContext: The Reporter system, like the systems before it, allow for objects that consume values to be constructed prior to the produce objects. When a value is requested either by a producer (Reporter) or consumer (ReporterInterface) the data is allocated. As such the assigned default value from the producer should not be relied upon on the consumer side during object construction.
NOTE: The ReporterContext is just a mechanism to allow for handling of values in special ways. In practice it might be better to have specific methods for these special cases. For example, a declareBroadcastValue, etc. Please refer to the ReporterData object for more information on how the data system operates for Reporter values.
Definition at line 206 of file Reporter.h.
207{
209}
const ReporterMode REPORTER_MODE_UNSET
1.9.8