Face_ID Struct Reference

A global ID of a face. More...

#include <RFC_Window_base.h>

Public Member Functions
	Face_ID ()
	A dummy constructor. More...
	Face_ID (int p, int f)
	Constructor from two integers. More...
bool	operator== (const Face_ID &v) const
	Equal operator. More...
bool	operator< (const Face_ID &v) const
	Less-than operator. More...

Public Attributes
int	pane_id
	the id of the owner pane. More...
int	face_id
	the local id within the pane starting from 1. More...

Detailed Description

A global ID of a face.

Each face is identified by a pair of integers: the pane id of its owner, and its local id of within the pane.

Definition at line 82 of file RFC_Window_base.h.

Constructor & Destructor Documentation

Face_ID ( )

inline

A dummy constructor.

Definition at line 84 of file RFC_Window_base.h.

{}

Face_ID ( int  p, int  f  )

inline

Constructor from two integers.

Parameters

p	the id of the owner pane.
f	the local id within the pane.

Definition at line 90 of file RFC_Window_base.h.

: pane_id( p), face_id( f) {}

Member Function Documentation

bool operator< ( const Face_ID &  v ) const

inline

Less-than operator.

Definition at line 99 of file RFC_Window_base.h.

References face_id, and pane_id.

                                          {
    return (pane_id < v.pane_id ||
            pane_id == v.pane_id && face_id < v.face_id); 
  }

bool operator== ( const Face_ID &  v ) const

inline

Equal operator.

Definition at line 96 of file RFC_Window_base.h.

References face_id, and pane_id.

  { return pane_id == v.pane_id && face_id == v.face_id; }

Member Data Documentation

int face_id

the local id within the pane starting from 1.

Definition at line 93 of file RFC_Window_base.h.

Referenced by RFC_Window_transfer::incident_faces(), Transfer_base::init_load_vector(), operator<(), operator==(), and Transfer_base::transfer_2f().

int pane_id

the id of the owner pane.

Definition at line 92 of file RFC_Window_base.h.

Referenced by RFC_Window_transfer::incident_faces(), Transfer_base::init_load_vector(), operator<(), operator==(), RFC_Window_transfer::replicate_metadata(), and Transfer_base::transfer_2f().

---

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

• RFC_Window_base.h