Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::HypergraphAttributes Class Reference

Stores additional attributes of a hypergraph. More...

#include <ogdf/hypergraph/HypergraphAttributes.h>

+ Inheritance diagram for ogdf::HypergraphAttributes:

Public Member Functions

 HypergraphAttributes ()
 Initializes new instance of class HypergraphAttributes. More...
 
 HypergraphAttributes (const Hypergraph &H)
 Initializes new instance of class HypergraphAttributes. More...
 
virtual ~HypergraphAttributes ()
 Destructor. More...
 
const HypergraphconstHypergraph () const
 
const double & height (hypernode v)
 Returns the height of the bounding box of hypernode v. More...
 
string & label (hypernode v)
 Returns the label of hypernode v. More...
 
void setHeight (hypernode v, int pHeight)
 Sets the the height of hypernode v. More...
 
void setWidth (hypernode v, int pWidth)
 Sets the the width of hypernode v. More...
 
void setX (hypernode v, double pX)
 Sets the x-coordinate of hypernode v. More...
 
void setY (hypernode v, double pY)
 Sets the y-coordinate of hypernode v. More...
 
int shape (hypernode v)
 Returns the shape of hypernode v. More...
 
const double & width (hypernode v)
 Returns the width of the bounding box of hypernode v. More...
 
const double & x (hypernode v)
 Returns the x-coordinate of hypernode v. More...
 
const double & y (hypernode v)
 Returns the y-coordinate of hypernode v. More...
 

Protected Attributes

HypernodeArray< double > m_height
 Height of a hypernodes bounding box. More...
 
const Hypergraphm_hypergraph
 Only points to an existing hypergraph. More...
 
HypernodeArray< string > m_label
 Label of a hypernode. More...
 
HypernodeArray< int > m_shape
 Shape of a hypernode. More...
 
HypernodeArray< double > m_width
 Width of a hypernode bounding box. More...
 
HypernodeArray< double > m_x
 Coordinate x of a hypernod.e. More...
 
HypernodeArray< double > m_y
 Coordinate y of a hypernode. More...
 

Detailed Description

Stores additional attributes of a hypergraph.

Because of different representation standards of hypergraphs (edge or subset) there are two different classes for hypergraph attributes. The main reason is that some edge standard attributes are pointless in t subset standard representation and vice-versa. Common attributes, currently various hypernode attributes only, are pushed to the superclass HypergraphAttributes.

Similarly to GraphAttributes, attributes are simply stored in hypernode or hyperedge arrays.

Definition at line 54 of file HypergraphAttributes.h.

Constructor & Destructor Documentation

◆ HypergraphAttributes() [1/2]

ogdf::HypergraphAttributes::HypergraphAttributes ( )
inline

Initializes new instance of class HypergraphAttributes.

Definition at line 82 of file HypergraphAttributes.h.

◆ HypergraphAttributes() [2/2]

ogdf::HypergraphAttributes::HypergraphAttributes ( const Hypergraph H)
inlineexplicit

Initializes new instance of class HypergraphAttributes.

Definition at line 88 of file HypergraphAttributes.h.

◆ ~HypergraphAttributes()

virtual ogdf::HypergraphAttributes::~HypergraphAttributes ( )
inlinevirtual

Destructor.

Definition at line 100 of file HypergraphAttributes.h.

Member Function Documentation

◆ constHypergraph()

const Hypergraph& ogdf::HypergraphAttributes::constHypergraph ( ) const
inline

Definition at line 104 of file HypergraphAttributes.h.

◆ height()

const double& ogdf::HypergraphAttributes::height ( hypernode  v)
inline

Returns the height of the bounding box of hypernode v.

Definition at line 145 of file HypergraphAttributes.h.

◆ label()

string& ogdf::HypergraphAttributes::label ( hypernode  v)
inline

Returns the label of hypernode v.

Definition at line 163 of file HypergraphAttributes.h.

◆ setHeight()

void ogdf::HypergraphAttributes::setHeight ( hypernode  v,
int  pHeight 
)
inline

Sets the the height of hypernode v.

Definition at line 151 of file HypergraphAttributes.h.

◆ setWidth()

void ogdf::HypergraphAttributes::setWidth ( hypernode  v,
int  pWidth 
)
inline

Sets the the width of hypernode v.

Definition at line 139 of file HypergraphAttributes.h.

◆ setX()

void ogdf::HypergraphAttributes::setX ( hypernode  v,
double  pX 
)
inline

Sets the x-coordinate of hypernode v.

Definition at line 116 of file HypergraphAttributes.h.

◆ setY()

void ogdf::HypergraphAttributes::setY ( hypernode  v,
double  pY 
)
inline

Sets the y-coordinate of hypernode v.

Definition at line 127 of file HypergraphAttributes.h.

◆ shape()

int ogdf::HypergraphAttributes::shape ( hypernode  v)
inline

Returns the shape of hypernode v.

Definition at line 157 of file HypergraphAttributes.h.

◆ width()

const double& ogdf::HypergraphAttributes::width ( hypernode  v)
inline

Returns the width of the bounding box of hypernode v.

Definition at line 133 of file HypergraphAttributes.h.

◆ x()

const double& ogdf::HypergraphAttributes::x ( hypernode  v)
inline

Returns the x-coordinate of hypernode v.

Definition at line 110 of file HypergraphAttributes.h.

◆ y()

const double& ogdf::HypergraphAttributes::y ( hypernode  v)
inline

Returns the y-coordinate of hypernode v.

Definition at line 122 of file HypergraphAttributes.h.

Member Data Documentation

◆ m_height

HypernodeArray<double> ogdf::HypergraphAttributes::m_height
protected

Height of a hypernodes bounding box.

Definition at line 74 of file HypergraphAttributes.h.

◆ m_hypergraph

const Hypergraph* ogdf::HypergraphAttributes::m_hypergraph
protected

Only points to an existing hypergraph.

Definition at line 59 of file HypergraphAttributes.h.

◆ m_label

HypernodeArray<string> ogdf::HypergraphAttributes::m_label
protected

Label of a hypernode.

Definition at line 62 of file HypergraphAttributes.h.

◆ m_shape

HypernodeArray<int> ogdf::HypergraphAttributes::m_shape
protected

Shape of a hypernode.

Definition at line 77 of file HypergraphAttributes.h.

◆ m_width

HypernodeArray<double> ogdf::HypergraphAttributes::m_width
protected

Width of a hypernode bounding box.

Definition at line 71 of file HypergraphAttributes.h.

◆ m_x

HypernodeArray<double> ogdf::HypergraphAttributes::m_x
protected

Coordinate x of a hypernod.e.

Definition at line 65 of file HypergraphAttributes.h.

◆ m_y

HypernodeArray<double> ogdf::HypergraphAttributes::m_y
protected

Coordinate y of a hypernode.

Definition at line 68 of file HypergraphAttributes.h.


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