The Sparta Modeling Framework
Loading...
Searching...
No Matches
sparta::app::ParameterDefaultApplicator Class Reference

Applies a new default value to a parameter node pattern. More...

#include <ConfigApplicators.hpp>

Inheritance diagram for sparta::app::ParameterDefaultApplicator:
Collaboration diagram for sparta::app::ParameterDefaultApplicator:

Public Member Functions

 ParameterDefaultApplicator (const std::string &loc_pattern, const std::string &value, ApplySuccessCondition required=ApplySuccessCondition::ASC_MUST_ASSIGN)
 
std::string stringize () const override
 Render this parameter action as a string.
 
void tryApply (sparta::TreeNode *root, ApplySuccessCondition required, ApplyFilter filter=ApplyFilter(), bool verbose=false) const override
 Apply the parameter contained in this object to the tree starting at root.
 
void applyUnbound (sparta::ParameterTree &ptree, bool verbose=false) const override
 Apply the parameter contained in this object to the unbound (virtual) parameter tree ptree.
 
- Public Member Functions inherited from sparta::app::ConfigApplicator
virtual ~ConfigApplicator ()
 Virtual destructor.
 
void apply (sparta::TreeNode *root, ApplyFilter filter=ApplyFilter(), bool verbose=false)
 Apply the parameter contained in this object to the tree starting at root.
 

Additional Inherited Members

- Public Types inherited from sparta::app::ConfigApplicator
enum class  ApplySuccessCondition { ASC_DEFER = 0 , ASC_MUST_ASSIGN = 1 , ASC_IGNORE = 2 , MAX_ASC }
 Type for dictating how tryApply should behave. More...
 
enum class  LocationFilter { ALL = 0 , AT_OR_BELOW_NODE , MAX_AF }
 Type for dictating how to filter the parameter application. (i.e. only apply to certain parts of the tree) More...
 

Detailed Description

Applies a new default value to a parameter node pattern.

Definition at line 378 of file ConfigApplicators.hpp.

Constructor & Destructor Documentation

◆ ParameterDefaultApplicator()

sparta::app::ParameterDefaultApplicator::ParameterDefaultApplicator ( const std::string &  loc_pattern,
const std::string &  value,
ApplySuccessCondition  required = ApplySuccessCondition::ASC_MUST_ASSIGN 
)
inline

Definition at line 407 of file ConfigApplicators.hpp.

Member Function Documentation

◆ applyUnbound()

void sparta::app::ParameterDefaultApplicator::applyUnbound ( sparta::ParameterTree ptree,
bool  verbose = false 
) const
inlineoverridevirtual

Apply the parameter contained in this object to the unbound (virtual) parameter tree ptree.

Note
This is done before device-tree-building so that parameters can be used for defining topology

Implements sparta::app::ConfigApplicator.

Definition at line 516 of file ConfigApplicators.hpp.

Here is the call graph for this function:

◆ stringize()

std::string sparta::app::ParameterDefaultApplicator::stringize ( ) const
inlineoverridevirtual

Render this parameter action as a string.

Implements sparta::app::ConfigApplicator.

Definition at line 413 of file ConfigApplicators.hpp.

◆ tryApply()

void sparta::app::ParameterDefaultApplicator::tryApply ( sparta::TreeNode root,
ApplySuccessCondition  required,
ApplyFilter  filter = ApplyFilter(),
bool  verbose = false 
) const
inlineoverridevirtual

Apply the parameter contained in this object to the tree starting at root.

Parameters
rootRoot of tree to apply parameter(s) too
Todo:
Allow meta-data attached to virtual parameter trees

Implements sparta::app::ConfigApplicator.

Definition at line 431 of file ConfigApplicators.hpp.

Here is the call graph for this function:

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