SST  14.0.0
StructuralSimulationToolkit
SST::LinkPair Class Reference

Defines a pair of links (to define a connected link) More...

#include <linkPair.h>

Public Member Functions

 LinkPair (LinkId_t order)
 Create a new LinkPair. More...
 
 LinkPair (LinkId_t order, LinkId_t remote_tag)
 Create a new LinkPair. More...
 
LinkgetLeft ()
 Return the Left Link. More...
 
LinkgetRight ()
 Return the Right Link. More...
 

Detailed Description

Defines a pair of links (to define a connected link)

Constructor & Destructor Documentation

◆ LinkPair() [1/2]

SST::LinkPair::LinkPair ( LinkId_t  order)
inline

Create a new LinkPair.

This is used when the endpoints are in the same partition.

Parameters
orderValue used to enforce the link order.

References SST::Link::pair_link.

◆ LinkPair() [2/2]

SST::LinkPair::LinkPair ( LinkId_t  order,
LinkId_t  remote_tag 
)
inline

Create a new LinkPair.

This is used when the endpoints are in different partitions.

Parameters
orderValue used to enforce the link order.
remote_tagUsed to look up the correct link on the other side.

References SST::Link::pair_link.

Member Function Documentation

◆ getLeft()

Link* SST::LinkPair::getLeft ( )
inline

Return the Left Link.

Returns
Left link

◆ getRight()

Link* SST::LinkPair::getRight ( )
inline

Return the Right Link.

Returns
Right link

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