PandA-2024.02
Public Member Functions | Data Fields
xml_foreach_t Class Reference

Foreach block, where the set of script nodes is applied to each parameter. More...

#include <xml_script_command.hpp>

Inheritance diagram for xml_foreach_t:
Inheritance graph
[legend]
Collaboration diagram for xml_foreach_t:
Collaboration graph
[legend]

Public Member Functions

 xml_foreach_t (std::string _variable)
 
 xml_foreach_t (const xml_element *element)
 
std::string get_xml_name () const override
 Gets the XML element name of this node type. More...
 
xml_nodeRef create_xml_node () const override
 Creates an XML node for polixml data structures. More...
 
 ~xml_foreach_t () override
 
void clean () override
 Cleans object attributes. More...
 
- Public Member Functions inherited from xml_script_node_t
virtual bool checkCondition (const DesignParametersRef &dp) const
 If the node has a compile-time condition, this method evaluates it. More...
 
 xml_script_node_t (xml_script_node_enum_t _type)
 
virtual ~xml_script_node_t ()
 

Data Fields

std::string variable
 
std::vector< xml_script_node_tRefNodes
 
- Data Fields inherited from xml_script_node_t
xml_script_node_enum_t nodeType
 

Additional Inherited Members

- Static Public Member Functions inherited from xml_script_node_t
static xml_script_node_enum_t find_type (const xml_element *element)
 Finds the type of an XML element. More...
 
static xml_script_node_tcreate (const xml_element *element)
 Creates a script node by parsing the XML element. More...
 
static bool evaluate_condition (const std::string *condition)
 Evaluates a string condition. More...
 
static bool evaluate_condition (const std::string *condition, const DesignParametersRef &dp)
 Evaluates a string condition. More...
 

Detailed Description

Foreach block, where the set of script nodes is applied to each parameter.

Definition at line 305 of file xml_script_command.hpp.

Constructor & Destructor Documentation

◆ xml_foreach_t() [1/2]

xml_foreach_t::xml_foreach_t ( std::string  _variable)
explicit

Definition at line 856 of file xml_script_command.cpp.

◆ xml_foreach_t() [2/2]

xml_foreach_t::xml_foreach_t ( const xml_element element)
explicit

◆ ~xml_foreach_t()

xml_foreach_t::~xml_foreach_t ( )
override

Definition at line 892 of file xml_script_command.cpp.

References clean().

Here is the call graph for this function:

Member Function Documentation

◆ clean()

void xml_foreach_t::clean ( )
overridevirtual

Cleans object attributes.

Implements xml_script_node_t.

Definition at line 897 of file xml_script_command.cpp.

References Nodes.

Referenced by ~xml_foreach_t().

Here is the caller graph for this function:

◆ create_xml_node()

xml_nodeRef xml_foreach_t::create_xml_node ( ) const
overridevirtual

Creates an XML node for polixml data structures.

Implements xml_script_node_t.

Definition at line 907 of file xml_script_command.cpp.

References get_xml_name(), and NOT_YET_IMPLEMENTED.

Here is the call graph for this function:

◆ get_xml_name()

std::string xml_foreach_t::get_xml_name ( ) const
overridevirtual

Gets the XML element name of this node type.

Implements xml_script_node_t.

Definition at line 902 of file xml_script_command.cpp.

References TAG_FOREACH.

Referenced by create_xml_node().

Here is the caller graph for this function:

Field Documentation

◆ Nodes

std::vector<xml_script_node_tRef> xml_foreach_t::Nodes

Definition at line 309 of file xml_script_command.hpp.

Referenced by clean(), and xml_foreach_t().

◆ variable

std::string xml_foreach_t::variable

Definition at line 308 of file xml_script_command.hpp.

Referenced by xml_foreach_t().


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

Generated on Mon Feb 12 2024 13:04:11 for PandA-2024.02 by doxygen 1.8.13