Antares Simulator
Power System Simulator
Antares::Expressions::Nodes::PortFieldSumNode Class Referencefinal

Represents a port field node where the expression is a sum. More...

#include <PortFieldSumNode.h>

Inheritance diagram for Antares::Expressions::Nodes::PortFieldSumNode:
Antares::Expressions::Nodes::Node Antares::Expressions::IName

Public Member Functions

 PortFieldSumNode (const std::string &port_name, const std::string &field_name)
 Constructs a port field sum node with the specified port and field names. More...
 
const std::string & getPortName () const
 Retrieves the port name. More...
 
const std::string & getFieldName () const
 Retrieves the field name. More...
 
bool operator== (const PortFieldSumNode &other) const =default
 
std::string name () const override
 
- Public Member Functions inherited from Antares::Expressions::IName
bool operator== (const IName &other) const =default
 

Detailed Description

Represents a port field node where the expression is a sum.

Constructor & Destructor Documentation

◆ PortFieldSumNode()

Antares::Expressions::Nodes::PortFieldSumNode::PortFieldSumNode ( const std::string &  port_name,
const std::string &  field_name 
)
explicit

Constructs a port field sum node with the specified port and field names.

Parameters
port_nameThe port name.
field_nameThe field name.

Member Function Documentation

◆ getFieldName()

const std::string & Antares::Expressions::Nodes::PortFieldSumNode::getFieldName ( ) const

Retrieves the field name.

Returns
The field name.

◆ getPortName()

const std::string & Antares::Expressions::Nodes::PortFieldSumNode::getPortName ( ) const

Retrieves the port name.

Returns
The port name.

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