jlm::util::graph::OutputPort Class Reference

#include <GraphWriter.hpp>

Inheritance diagram for jlm::util::graph::OutputPort:

Collaboration diagram for jlm::util::graph::OutputPort:

Public Member Functions
	~OutputPort () override=default
const char *	GetIdPrefix () const override
Node &	GetNode () override
bool	CanBeEdgeHead () const override
void	SetFillColor (std::string color) override
void	OutputDotPortId (std::ostream &out) const override
Public Member Functions inherited from jlm::util::graph::Port
	~Port () override=default
Graph &	GetGraph () override
virtual bool	CanBeEdgeTail () const
const std::vector< Edge * > &	GetConnections () const
bool	HasOutgoingEdges () const
bool	HasIncomingEdges () const
void	OutputIncomingEdgesASCII (std::ostream &out) const
Public Member Functions inherited from jlm::util::graph::GraphElement
virtual	~GraphElement ()=default
	GraphElement ()
	GraphElement (const GraphElement &other)=delete
	GraphElement (GraphElement &&other)=delete
GraphElement &	operator= (const GraphElement &other)=delete
GraphElement &	operator= (GraphElement &&other)=delete
std::string	GetFullId () const
const Graph &	GetGraph () const
void	SetLabel (std::string label)
void	AppendToLabel (std::string_view text, std::string_view sep="\n")
bool	HasLabel () const
const std::string &	GetLabel () const
std::string_view	GetLabelOr (std::string_view otherwise) const
size_t	GetUniqueIdSuffix () const
template<typename T >
void	SetProgramObject (const T &object)
void	RemoveProgramObject ()
bool	HasProgramObject () const noexcept
uintptr_t	GetProgramObject () const noexcept
void	SetAttribute (const std::string &attribute, std::string value)
void	SetAttributeObject (const std::string &attribute, uintptr_t object)
template<typename T >
void	SetAttributeObject (const std::string &attribute, const T &object)
void	SetAttributeGraphElement (const std::string &attribute, const GraphElement &element)
bool	HasAttribute (const std::string &attribute) const
std::optional< std::string_view >	GetAttributeString (const std::string &attribute) const
std::optional< uintptr_t >	GetAttributeObject (const std::string &attribute) const
const GraphElement *	GetAttributeGraphElement (const std::string &attribute) const
bool	RemoveAttribute (const std::string &attribute)
virtual void	Finalize ()
bool	IsFinalized () const
void	OutputAttributes (std::ostream &out, AttributeOutputFormat format) const

Private Member Functions
	OutputPort (InOutNode &node)

Private Attributes
friend	InOutNode
InOutNode &	Node_

Additional Inherited Members
Protected Member Functions inherited from jlm::util::graph::Port
	Port ()

Detailed Description

The output port of an InOutNode

Definition at line 486 of file GraphWriter.hpp.

Constructor & Destructor Documentation

OutputPort()

jlm::util::graph::OutputPort::OutputPort ( InOutNode &  node )

explicitprivate

Definition at line 628 of file GraphWriter.cpp.

~OutputPort()

jlm::util::graph::OutputPort::~OutputPort ( )

overridedefault

Member Function Documentation

CanBeEdgeHead()

bool jlm::util::graph::OutputPort::CanBeEdgeHead ( ) const

overridevirtual

Returns

true if a directed edge may have its head at this port, false otherwise

Reimplemented from jlm::util::graph::Port.

Definition at line 647 of file GraphWriter.cpp.

GetIdPrefix()

const char * jlm::util::graph::OutputPort::GetIdPrefix ( ) const

overridevirtual

Gets a short string that will serve as the base for a unique ID. This base should be a valid C-like identifier.

Returns

a string, such as "node", "i", "o", "graph"

Implements jlm::util::graph::GraphElement.

Definition at line 635 of file GraphWriter.cpp.

GetNode()

Node & jlm::util::graph::OutputPort::GetNode ( )

overridevirtual

Implements jlm::util::graph::Port.

Definition at line 641 of file GraphWriter.cpp.

OutputDotPortId()

void jlm::util::graph::OutputPort::OutputDotPortId ( std::ostream &  out ) const

overridevirtual

Outputs the fully qualified port name, such as node8:i6:n Only used by the Dot printer.

Implements jlm::util::graph::Port.

Definition at line 660 of file GraphWriter.cpp.

SetFillColor()

void jlm::util::graph::OutputPort::SetFillColor ( std::string  color )

overridevirtual

Helper function for setting the background color of the Port using the correct dot attributes.

Parameters

color

an X11 color name or an RGB value in hex, prefixed by '#'

See also

jlm::util::Colors namespace for a list of common colors.

Implements jlm::util::graph::Port.

Definition at line 653 of file GraphWriter.cpp.

Member Data Documentation

InOutNode

friend jlm::util::graph::OutputPort::InOutNode

private

Definition at line 488 of file GraphWriter.hpp.

Node_

InOutNode& jlm::util::graph::OutputPort::Node_

private

Definition at line 511 of file GraphWriter.hpp.

---

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

• jlm/util/GraphWriter.hpp
• jlm/util/GraphWriter.cpp