Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

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

Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from ogdf::HypergraphAttributes
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 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 182 of file HypergraphAttributes.h.

Constructor & Destructor Documentation

◆ HypergraphAttributesES() [1/2]

ogdf::HypergraphAttributesES::HypergraphAttributesES ( )
inline

Initializes new instance of class HypergraphAttributes.

Definition at line 198 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 204 of file HypergraphAttributes.h.

◆ ~HypergraphAttributesES()

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

Destructor.

Definition at line 217 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 342 of file HypergraphAttributes.h.

◆ boundingBox()

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

Returns the bounding box of the hypergraph.

Definition at line 373 of file HypergraphAttributes.h.

◆ clearAllBends()

void ogdf::HypergraphAttributesES::clearAllBends ( )
inline

Definition at line 361 of file HypergraphAttributes.h.

◆ height()

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

Returns the height of a representation node v.

Definition at line 320 of file HypergraphAttributes.h.

◆ removeUnnecessaryBendsHV()

void ogdf::HypergraphAttributesES::removeUnnecessaryBendsHV ( )
inline

Removes unnecessary bend points in orthogonal segements.

Definition at line 367 of file HypergraphAttributes.h.

◆ repGA()

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

Definition at line 233 of file HypergraphAttributes.h.

◆ repGraph()

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

Definition at line 228 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 326 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 333 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 304 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 311 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 269 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 260 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 282 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 289 of file HypergraphAttributes.h.

◆ type() [1/3]

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

Definition at line 223 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 239 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 245 of file HypergraphAttributes.h.

◆ width()

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

Returns the width of a representation node v.

Definition at line 298 of file HypergraphAttributes.h.

◆ x()

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

Returns the x-coordinate of representation node v.

Definition at line 254 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 276 of file HypergraphAttributes.h.

Member Data Documentation

◆ m_repG

EdgeStandardRep* ogdf::HypergraphAttributesES::m_repG
private

Edge standard representation reference.

Definition at line 190 of file HypergraphAttributes.h.

◆ m_repGA

GraphAttributes* ogdf::HypergraphAttributesES::m_repGA
private

Wrapped graph attributes reference.

Definition at line 187 of file HypergraphAttributes.h.

◆ m_type

EdgeStandardType ogdf::HypergraphAttributesES::m_type
private

The type of of edge standard representation.

Definition at line 193 of file HypergraphAttributes.h.


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