Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

Loading...
Searching...
No Matches
ogdf::HypergraphAttributesES Class Reference

Stores additional attributes of edge standard representation of a hypergraph. More...

#include <ogdf/hypergraph/HypergraphAttributes.h>

+ Inheritance diagram for ogdf::HypergraphAttributesES:

Public Member Functions

 HypergraphAttributesES ()
 Initializes new instance of class HypergraphAttributes.
 
 HypergraphAttributesES (const Hypergraph &pH, EdgeStandardType pType=EdgeStandardType::star)
 Initializes new instance of class HypergraphAttributes.
 
virtual ~HypergraphAttributesES ()
 Destructor.
 
DPolylinebends (edge e)
 Returns the list of bend points of edge e.
 
const DRect boundingBox () const
 Returns the bounding box of the hypergraph.
 
void clearAllBends ()
 
const doubleheight (node v)
 Returns the height of a representation node v.
 
void removeUnnecessaryBendsHV ()
 Removes unnecessary bend points in orthogonal segements.
 
const GraphAttributesrepGA () const
 
const GraphrepGraph () const
 
void setHeight (hypernode v, double pHeight)
 Sets the the height of hypernode v.
 
void setHeight (node v, double pHeight)
 Sets the the height of a representation node v.
 
void setWidth (hypernode v, double pWidth)
 Sets the the width of hypernode v.
 
void setWidth (node v, double pWidth)
 Sets the the width of a representation node v.
 
void setX (hypernode v, double pX)
 Sets the x-coordinate of hypernode v.
 
void setX (node v, double pX)
 Sets the x-coordinate of a representation node v.
 
void setY (hypernode v, double pY)
 Sets the x-coordinate of hypernode v.
 
void setY (node v, double pY)
 Sets the y-coordinate of a representation node v.
 
EdgeStandardType type () const
 
HypernodeElement::Type type (hypernode v)
 Returns the type of representation node v.
 
HypernodeElement::Type type (node v)
 Returns the type of representation node v.
 
const doublewidth (node v)
 Returns the width of a representation node v.
 
const doublex (node v)
 Returns the x-coordinate of representation node v.
 
const doubley (node v)
 Returns the y-coordinate of a representation node v.
 
- Public Member Functions inherited from ogdf::HypergraphAttributes
 HypergraphAttributes ()
 Initializes new instance of class HypergraphAttributes.
 
 HypergraphAttributes (const Hypergraph &H)
 Initializes new instance of class HypergraphAttributes.
 
virtual ~HypergraphAttributes ()
 Destructor.
 
const HypergraphconstHypergraph () const
 
const doubleheight (hypernode v)
 Returns the height of the bounding box of hypernode v.
 
string & label (hypernode v)
 Returns the label of hypernode v.
 
void setHeight (hypernode v, int pHeight)
 Sets the the height of hypernode v.
 
void setWidth (hypernode v, int pWidth)
 Sets the the width of hypernode v.
 
void setX (hypernode v, double pX)
 Sets the x-coordinate of hypernode v.
 
void setY (hypernode v, double pY)
 Sets the y-coordinate of hypernode v.
 
int shape (hypernode v)
 Returns the shape of hypernode v.
 
const doublewidth (hypernode v)
 Returns the width of the bounding box of hypernode v.
 
const doublex (hypernode v)
 Returns the x-coordinate of hypernode v.
 
const doubley (hypernode v)
 Returns the y-coordinate of hypernode v.
 

Private Attributes

EdgeStandardRepm_repG
 Edge standard representation reference.
 
GraphAttributesm_repGA
 Wrapped graph attributes reference.
 
EdgeStandardType m_type
 The type of of edge standard representation.
 

Additional Inherited Members

- Protected Attributes inherited from ogdf::HypergraphAttributes
HypernodeArray< doublem_height
 Height of a hypernodes bounding box.
 
const Hypergraphm_hypergraph
 Only points to an existing hypergraph.
 
HypernodeArray< string > m_label
 Label of a hypernode.
 
HypernodeArray< intm_shape
 Shape of a hypernode.
 
HypernodeArray< doublem_width
 Width of a hypernode bounding box.
 
HypernodeArray< doublem_x
 Coordinate x of a hypernod.e.
 
HypernodeArray< doublem_y
 Coordinate y of a hypernode.
 

Detailed Description

Stores additional attributes of edge standard representation of a hypergraph.

Since edge standard representation is in fact just an ordinary graph, all its attributes are stored in wrapped instance of GraphAttributes class. Some nodes in the representation are yet specific since they represent hypernodes, attributes of these are driven explicitly from this class.

Superclass is declared as pure virtual to make dynamic casting possible.

Definition at line 139 of file HypergraphAttributes.h.

Constructor & Destructor Documentation

◆ HypergraphAttributesES() [1/2]

ogdf::HypergraphAttributesES::HypergraphAttributesES ( )
inline

Initializes new instance of class HypergraphAttributes.

Definition at line 152 of file HypergraphAttributes.h.

◆ HypergraphAttributesES() [2/2]

ogdf::HypergraphAttributesES::HypergraphAttributesES ( const Hypergraph pH,
EdgeStandardType  pType = EdgeStandardType::star 
)
inlineexplicit

Initializes new instance of class HypergraphAttributes.

Definition at line 155 of file HypergraphAttributes.h.

◆ ~HypergraphAttributesES()

virtual ogdf::HypergraphAttributesES::~HypergraphAttributesES ( )
inlinevirtual

Destructor.

Definition at line 167 of file HypergraphAttributes.h.

Member Function Documentation

◆ bends()

DPolyline & ogdf::HypergraphAttributesES::bends ( edge  e)
inline

Returns the list of bend points of edge e.

Definition at line 263 of file HypergraphAttributes.h.

◆ boundingBox()

const DRect ogdf::HypergraphAttributesES::boundingBox ( ) const
inline

Returns the bounding box of the hypergraph.

Definition at line 285 of file HypergraphAttributes.h.

◆ clearAllBends()

void ogdf::HypergraphAttributesES::clearAllBends ( )
inline

Definition at line 279 of file HypergraphAttributes.h.

◆ height()

const double & ogdf::HypergraphAttributesES::height ( node  v)
inline

Returns the height of a representation node v.

Definition at line 245 of file HypergraphAttributes.h.

◆ removeUnnecessaryBendsHV()

void ogdf::HypergraphAttributesES::removeUnnecessaryBendsHV ( )
inline

Removes unnecessary bend points in orthogonal segements.

Definition at line 282 of file HypergraphAttributes.h.

◆ repGA()

const GraphAttributes & ogdf::HypergraphAttributesES::repGA ( ) const
inline

Definition at line 176 of file HypergraphAttributes.h.

◆ repGraph()

const Graph & ogdf::HypergraphAttributesES::repGraph ( ) const
inline

Definition at line 174 of file HypergraphAttributes.h.

◆ setHeight() [1/2]

void ogdf::HypergraphAttributesES::setHeight ( hypernode  v,
double  pHeight 
)
inline

Sets the the height of hypernode v.

Definition at line 248 of file HypergraphAttributes.h.

◆ setHeight() [2/2]

void ogdf::HypergraphAttributesES::setHeight ( node  v,
double  pHeight 
)
inline

Sets the the height of a representation node v.

Definition at line 254 of file HypergraphAttributes.h.

◆ setWidth() [1/2]

void ogdf::HypergraphAttributesES::setWidth ( hypernode  v,
double  pWidth 
)
inline

Sets the the width of hypernode v.

Definition at line 230 of file HypergraphAttributes.h.

◆ setWidth() [2/2]

void ogdf::HypergraphAttributesES::setWidth ( node  v,
double  pWidth 
)
inline

Sets the the width of a representation node v.

Definition at line 236 of file HypergraphAttributes.h.

◆ setX() [1/2]

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

Sets the x-coordinate of hypernode v.

Definition at line 203 of file HypergraphAttributes.h.

◆ setX() [2/2]

void ogdf::HypergraphAttributesES::setX ( node  v,
double  pX 
)
inline

Sets the x-coordinate of a representation node v.

Definition at line 194 of file HypergraphAttributes.h.

◆ setY() [1/2]

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

Sets the x-coordinate of hypernode v.

Definition at line 212 of file HypergraphAttributes.h.

◆ setY() [2/2]

void ogdf::HypergraphAttributesES::setY ( node  v,
double  pY 
)
inline

Sets the y-coordinate of a representation node v.

Definition at line 218 of file HypergraphAttributes.h.

◆ type() [1/3]

EdgeStandardType ogdf::HypergraphAttributesES::type ( ) const
inline

Definition at line 172 of file HypergraphAttributes.h.

◆ type() [2/3]

HypernodeElement::Type ogdf::HypergraphAttributesES::type ( hypernode  v)
inline

Returns the type of representation node v.

Definition at line 179 of file HypergraphAttributes.h.

◆ type() [3/3]

HypernodeElement::Type ogdf::HypergraphAttributesES::type ( node  v)
inline

Returns the type of representation node v.

Definition at line 182 of file HypergraphAttributes.h.

◆ width()

const double & ogdf::HypergraphAttributesES::width ( node  v)
inline

Returns the width of a representation node v.

Definition at line 227 of file HypergraphAttributes.h.

◆ x()

const double & ogdf::HypergraphAttributesES::x ( node  v)
inline

Returns the x-coordinate of representation node v.

Definition at line 191 of file HypergraphAttributes.h.

◆ y()

const double & ogdf::HypergraphAttributesES::y ( node  v)
inline

Returns the y-coordinate of a representation node v.

Definition at line 209 of file HypergraphAttributes.h.

Member Data Documentation

◆ m_repG

EdgeStandardRep* ogdf::HypergraphAttributesES::m_repG
private

Edge standard representation reference.

Definition at line 145 of file HypergraphAttributes.h.

◆ m_repGA

GraphAttributes* ogdf::HypergraphAttributesES::m_repGA
private

Wrapped graph attributes reference.

Definition at line 142 of file HypergraphAttributes.h.

◆ m_type

EdgeStandardType ogdf::HypergraphAttributesES::m_type
private

The type of of edge standard representation.

Definition at line 148 of file HypergraphAttributes.h.


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