CGAL 5.1 - 2D Arrangements
ArrangementOutputFormatter Class Reference

#include <Concepts/ArrangementOutputFormatter.h>

Definition

A model for the ArrangementOutputFormatter concept supports a set of functions that enable writing an arrangement to an output stream using a specific format.

Has Models:

CGAL::Arr_text_formatter<Arrangement>

CGAL::Arr_face_extended_text_formatter<Arrangement>

CGAL::Arr_extended_dcel_text_formatter<Arrangement>

Types

typedef unspecified_type Arrangement_2
 the type of arrangement to output. More...
 
typedef Arrangement_2::Point_2 Point_2
 the point type. More...
 
typedef Arrangement_2::X_monotone_curve_2 X_monotone_curve_2
 the \( x\)-monotone curve type. More...
 
typedef Arrangement_2::Size Size
 
typedef Arrangement_2::Vertex_const_handle Vertex_const_handle
 
typedef Arrangement_2::Halfedge_const_handle Halfedge_const_handle
 
typedef Arrangement_2::Face_const_handle Face_const_handle
 

Creation

 Arr_out_formatter ()
 default constructor. More...
 
 Arr_out_formatter (std::ostream &os)
 constructs a formatter that writes to os. More...
 
void set_out (std::ostream &os)
 directs outf to write to os. More...
 

Access Functions

std::ostream & out ()
 returns the stream that outf writes to. More...
 

Formatted Output Functions

void write_arrangement_begin ()
 writes a message indicating the beginning of the arrangement. More...
 
void write_arrangement_end ()
 writes a message indicating the end of the arrangement. More...
 
void write_size (const char *label, Size size)
 writes a size value, preceded by a given label. More...
 
void write_vertices_begin ()
 writes a message indicating the beginning of the vertex records. More...
 
void write_vertices_end ()
 writes a message indicating the end of the vertex records. More...
 
void write_edges_begin ()
 writes a message indicating the beginning of the edge records. More...
 
void write_edges_end ()
 writes a message indicating the end of the edge records. More...
 
void write_faces_begin ()
 writes a message indicating the beginning of the face records. More...
 
void write_faces_end ()
 writes a message indicating the end of the face records. More...
 
void write_vertex_begin ()
 writes a message indicating the beginning of a single vertex record. More...
 
void write_vertex_end ()
 writes a message indicating the end of a single vertex record. More...
 
void write_vertex_index (std::size_t idx)
 writes a vertex index. More...
 
void write_point (const Point_2 &p)
 writes a point. More...
 
void write_vertex_data (Vertex_const_handle v)
 writes the auxiliary data associated with the vertex. More...
 
void write_edge_begin ()
 writes a message indicating the beginning of a single edge record. More...
 
void write_edge_end ()
 writes a message indicating the end of a single edge record. More...
 
void write_halfedge_index (std::size_t idx)
 writes a halfedge index. More...
 
void write_x_monotone_curve (const X_monotone_curve_2 &c)
 writes an \( x\)-monotone curve. More...
 
void write_halfegde_data (Halfedge_const_handle he)
 writes the auxiliary data associated with the halfedge. More...
 
void write_face_begin ()
 writes a message indicating the beginning of a single face record. More...
 
void write_face_end ()
 writes a message indicating the end of a single face record. More...
 
void write_outer_ccb_begin ()
 writes a message indicating the beginning of the outer CCB of the current face. More...
 
void write_outer_ccb_end ()
 writes a message indicating the end of the outer CCB of the current face. More...
 
void write_holes_begin ()
 writes a message indicating the beginning of the container of holes inside the current face. More...
 
void write_holes_end ()
 writes a message indicating the end of the container of holes inside the current face. More...
 
void write_ccb_halfedges_begin ()
 writes a message indicating the beginning a connected component's boundary. More...
 
void write_ccb_halfedges_end ()
 writes a message indicating the end of a connected component's boundary. More...
 
void write_isolated_vertices_begin ()
 writes a message indicating the beginning of the container of isolated vertices inside the current face. More...
 
void write_isolated_vertices_end ()
 writes a message indicating the end of the container of isolated vertices inside the current face. More...
 
void write_face_data (Face_const_handle f)
 writes the auxiliary data associated with the face. More...
 

Member Typedef Documentation

◆ Arrangement_2

the type of arrangement to output.

◆ Face_const_handle

typedef Arrangement_2::Face_const_handle ArrangementOutputFormatter::Face_const_handle

◆ Halfedge_const_handle

typedef Arrangement_2::Halfedge_const_handle ArrangementOutputFormatter::Halfedge_const_handle

◆ Point_2

typedef Arrangement_2::Point_2 ArrangementOutputFormatter::Point_2

the point type.

◆ Size

typedef Arrangement_2::Size ArrangementOutputFormatter::Size

◆ Vertex_const_handle

typedef Arrangement_2::Vertex_const_handle ArrangementOutputFormatter::Vertex_const_handle

◆ X_monotone_curve_2

typedef Arrangement_2::X_monotone_curve_2 ArrangementOutputFormatter::X_monotone_curve_2

the \( x\)-monotone curve type.

Member Function Documentation

◆ Arr_out_formatter() [1/2]

ArrangementOutputFormatter::Arr_out_formatter ( )

default constructor.

◆ Arr_out_formatter() [2/2]

ArrangementOutputFormatter::Arr_out_formatter ( std::ostream &  os)

constructs a formatter that writes to os.

◆ out()

std::ostream& ArrangementOutputFormatter::out ( )

returns the stream that outf writes to.

Precondition
outf is directed to a valid output stream.

◆ set_out()

void ArrangementOutputFormatter::set_out ( std::ostream &  os)

directs outf to write to os.

◆ write_arrangement_begin()

void ArrangementOutputFormatter::write_arrangement_begin ( )

writes a message indicating the beginning of the arrangement.

◆ write_arrangement_end()

void ArrangementOutputFormatter::write_arrangement_end ( )

writes a message indicating the end of the arrangement.

◆ write_ccb_halfedges_begin()

void ArrangementOutputFormatter::write_ccb_halfedges_begin ( )

writes a message indicating the beginning a connected component's boundary.

◆ write_ccb_halfedges_end()

void ArrangementOutputFormatter::write_ccb_halfedges_end ( )

writes a message indicating the end of a connected component's boundary.

◆ write_edge_begin()

void ArrangementOutputFormatter::write_edge_begin ( )

writes a message indicating the beginning of a single edge record.

◆ write_edge_end()

void ArrangementOutputFormatter::write_edge_end ( )

writes a message indicating the end of a single edge record.

◆ write_edges_begin()

void ArrangementOutputFormatter::write_edges_begin ( )

writes a message indicating the beginning of the edge records.

◆ write_edges_end()

void ArrangementOutputFormatter::write_edges_end ( )

writes a message indicating the end of the edge records.

◆ write_face_begin()

void ArrangementOutputFormatter::write_face_begin ( )

writes a message indicating the beginning of a single face record.

◆ write_face_data()

void ArrangementOutputFormatter::write_face_data ( Face_const_handle  f)

writes the auxiliary data associated with the face.

◆ write_face_end()

void ArrangementOutputFormatter::write_face_end ( )

writes a message indicating the end of a single face record.

◆ write_faces_begin()

void ArrangementOutputFormatter::write_faces_begin ( )

writes a message indicating the beginning of the face records.

◆ write_faces_end()

void ArrangementOutputFormatter::write_faces_end ( )

writes a message indicating the end of the face records.

◆ write_halfedge_index()

void ArrangementOutputFormatter::write_halfedge_index ( std::size_t  idx)

writes a halfedge index.

◆ write_halfegde_data()

void ArrangementOutputFormatter::write_halfegde_data ( Halfedge_const_handle  he)

writes the auxiliary data associated with the halfedge.

◆ write_holes_begin()

void ArrangementOutputFormatter::write_holes_begin ( )

writes a message indicating the beginning of the container of holes inside the current face.

◆ write_holes_end()

void ArrangementOutputFormatter::write_holes_end ( )

writes a message indicating the end of the container of holes inside the current face.

◆ write_isolated_vertices_begin()

void ArrangementOutputFormatter::write_isolated_vertices_begin ( )

writes a message indicating the beginning of the container of isolated vertices inside the current face.

◆ write_isolated_vertices_end()

void ArrangementOutputFormatter::write_isolated_vertices_end ( )

writes a message indicating the end of the container of isolated vertices inside the current face.

◆ write_outer_ccb_begin()

void ArrangementOutputFormatter::write_outer_ccb_begin ( )

writes a message indicating the beginning of the outer CCB of the current face.

◆ write_outer_ccb_end()

void ArrangementOutputFormatter::write_outer_ccb_end ( )

writes a message indicating the end of the outer CCB of the current face.

◆ write_point()

void ArrangementOutputFormatter::write_point ( const Point_2 p)

writes a point.

◆ write_size()

void ArrangementOutputFormatter::write_size ( const char *  label,
Size  size 
)

writes a size value, preceded by a given label.

◆ write_vertex_begin()

void ArrangementOutputFormatter::write_vertex_begin ( )

writes a message indicating the beginning of a single vertex record.

◆ write_vertex_data()

void ArrangementOutputFormatter::write_vertex_data ( Vertex_const_handle  v)

writes the auxiliary data associated with the vertex.

◆ write_vertex_end()

void ArrangementOutputFormatter::write_vertex_end ( )

writes a message indicating the end of a single vertex record.

◆ write_vertex_index()

void ArrangementOutputFormatter::write_vertex_index ( std::size_t  idx)

writes a vertex index.

◆ write_vertices_begin()

void ArrangementOutputFormatter::write_vertices_begin ( )

writes a message indicating the beginning of the vertex records.

◆ write_vertices_end()

void ArrangementOutputFormatter::write_vertices_end ( )

writes a message indicating the end of the vertex records.

◆ write_x_monotone_curve()

void ArrangementOutputFormatter::write_x_monotone_curve ( const X_monotone_curve_2 c)

writes an \( x\)-monotone curve.