PLCnext API Documentation 25.0.2.69
Public Member Functions | Friends | List of all members
Arp::Io::Commons::Configuration::TicArc Class Reference

This class defines a directed relation between two Tic items. More...

#include <TicArc.hpp>

Public Member Functions

 TicArc (const TicArc &arg)
 Default copy constructor.
 
 TicArc (TicArc &&arg) noexcept
 Default move constructor.
 
TicArcoperator= (const TicArc &arg)
 Default copy-assignment operator.
 
TicArcoperator= (TicArc &&arg) noexcept
 Default move-assignment operator.
 
 ~TicArc (void)
 Default destructor.
 
 TicArc (TicArcRole role, const TicNode &from, const TicNode &to)
 Constructs a TicArc instance. More...
 
TicArcRole GetRole (void) const
 The role of this arc. More...
 
const TicNodeGetFrom (void) const
 The name of the source of this arc. More...
 
const TicNodeGetTo (void) const
 The name of the destination of this arc. More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Friends

ARP_EXPORT friend bool operator== (const TicArc &lhs, const TicArc &rhs)
 Compares two arcs on equality. More...
 

Detailed Description

This class defines a directed relation between two Tic items.

Constructor & Destructor Documentation

◆ TicArc()

Arp::Io::Commons::Configuration::TicArc::TicArc ( TicArcRole  role,
const TicNode from,
const TicNode to 
)
explicit

Constructs a TicArc instance.

Parameters
roleThe role of this arc.
fromThe name of the source of this arc.
toThe name of the destination of this arc.

Member Function Documentation

◆ GetFrom()

const TicNode & Arp::Io::Commons::Configuration::TicArc::GetFrom ( void  ) const

The name of the source of this arc.

Returns
The source name of this arc.

◆ GetRole()

TicArcRole Arp::Io::Commons::Configuration::TicArc::GetRole ( void  ) const

The role of this arc.

Returns
The role of this arc.

◆ GetTo()

const TicNode & Arp::Io::Commons::Configuration::TicArc::GetTo ( void  ) const

The name of the destination of this arc.

Returns
The destination name of this arc.

Friends And Related Function Documentation

◆ operator==

ARP_EXPORT friend bool operator== ( const TicArc lhs,
const TicArc rhs 
)
friend

Compares two arcs on equality.

Parameters
lhsThe left operand to compare.
rhsThe right operand to compare.
Returns
true on equality, otherwise false.

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