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

Command line of the synthesis tool. More...

#include <xml_script_command.hpp>

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

Public Member Functions

 xml_command_t (const std::string *_name, const std::string *_value, const std::string *_condition, const std::string *_output)
 
 xml_command_t (const xml_element *element)
 
 ~xml_command_t () override
 
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...
 
void clean () override
 Cleans object attributes. More...
 
bool checkCondition (const DesignParametersRef &dp) const override
 If the node has a compile-time condition, this method evaluates it. More...
 
- Public Member Functions inherited from xml_script_node_t
 xml_script_node_t (xml_script_node_enum_t _type)
 
virtual ~xml_script_node_t ()
 

Data Fields

std::string * name
 
std::string * value
 
std::vector< xml_parameter_tRefparameters
 
std::string * condition
 
std::string * output
 
- 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

Command line of the synthesis tool.

Definition at line 227 of file xml_script_command.hpp.

Constructor & Destructor Documentation

◆ xml_command_t() [1/2]

xml_command_t::xml_command_t ( const std::string *  _name,
const std::string *  _value,
const std::string *  _condition,
const std::string *  _output 
)

Definition at line 525 of file xml_script_command.cpp.

References condition, name, output, parameters, and value.

◆ xml_command_t() [2/2]

xml_command_t::xml_command_t ( const xml_element element)
explicit

◆ ~xml_command_t()

xml_command_t::~xml_command_t ( )
override

Definition at line 582 of file xml_script_command.cpp.

References clean().

Here is the call graph for this function:

Member Function Documentation

◆ checkCondition()

bool xml_command_t::checkCondition ( const DesignParametersRef dp) const
overridevirtual

If the node has a compile-time condition, this method evaluates it.

Parameters
dpDesign parameters, used to check conditions at compile time.
Returns
The condition evaluation if any, otherwise is true by default.

Reimplemented from xml_script_node_t.

Definition at line 632 of file xml_script_command.cpp.

References condition, and xml_script_node_t::evaluate_condition().

Here is the call graph for this function:

◆ clean()

void xml_command_t::clean ( )
overridevirtual

Cleans object attributes.

Implements xml_script_node_t.

Definition at line 587 of file xml_script_command.cpp.

References condition, name, output, parameters, and value.

Referenced by ~xml_command_t().

Here is the caller graph for this function:

◆ create_xml_node()

xml_nodeRef xml_command_t::create_xml_node ( ) const
overridevirtual

Creates an XML node for polixml data structures.

Implements xml_script_node_t.

Definition at line 606 of file xml_script_command.cpp.

References condition, get_xml_name(), name, output, parameters, and value.

Here is the call graph for this function:

◆ get_xml_name()

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

Gets the XML element name of this node type.

Implements xml_script_node_t.

Definition at line 601 of file xml_script_command.cpp.

References TAG_COMMAND.

Referenced by create_xml_node().

Here is the caller graph for this function:

Field Documentation

◆ condition

std::string* xml_command_t::condition

Definition at line 233 of file xml_script_command.hpp.

Referenced by checkCondition(), clean(), create_xml_node(), and xml_command_t().

◆ name

std::string* xml_command_t::name

◆ output

std::string* xml_command_t::output

◆ parameters

std::vector<xml_parameter_tRef> xml_command_t::parameters

◆ value

std::string* xml_command_t::value

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