Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | Friends
vsol_group_2d Class Reference

#include <vsol_group_2d.h>

Inheritance diagram for vsol_group_2d:
Inheritance graph
[legend]

List of all members.

Public Types

enum  vsol_spatial_object_2d_type {
  SPATIAL_NO_TYPE = 0, TOPOLOGYOBJECT, POINT, CURVE,
  REGION, SPATIALGROUP, VOLUME, NUM_SPATIALOBJECT_TYPES
}

Public Member Functions

 vsol_group_2d (void)
 Default Constructor: group with no child.
 vsol_group_2d (const vsol_group_2d &other)
 Copy constructor.
virtual ~vsol_group_2d ()
 Destructor.
virtual vsol_spatial_object_2dclone (void) const
 Clone `this': creation of a new object and initialization.
vsol_spatial_object_2d_sptr object (unsigned int i) const
 Return the object `i'.
vsol_spatial_object_2d_type spatial_type (void) const
 Return the real type of a group. It is a SPATIALGROUP.
virtual void compute_bounding_box (void) const
 Compute the bounding box of `this'.
unsigned int size (void) const
 Return the number of direct children of the group.
unsigned int deep_size (void) const
 Return the number of objects of the group.
bool is_child (const vsol_spatial_object_2d_sptr &new_object) const
 Is `new_object' a child (direct or not) of `this' ?.
void add_object (const vsol_spatial_object_2d_sptr &new_object)
 Add an object `new_object' to `this'.
void remove_object (unsigned int i)
 Remove object `i' of `this' (not delete it).
virtual const vsol_group_2dcast_to_group (void) const
 The same behavior than dynamic_cast<>.
virtual vsol_group_2dcast_to_group (void)
virtual bool operator== (const vsol_group_2d &other) const
 Has `this' the same number of elements and as other and equal elements?.
virtual bool operator== (const vsol_spatial_object_2d &obj) const
bool operator!= (const vsol_group_2d &o) const
 Has `this' not the same number of elements and as other and not equal elements?.
void b_write (vsl_b_ostream &os) const
 Binary save self to stream.
void b_read (vsl_b_istream &is)
 Binary load self from stream.
short version () const
 Return IO version number;.
void print_summary (vcl_ostream &os) const
 Print an ascii summary to the stream.
virtual vcl_string is_a () const
 Return a platform independent string identifying the class.
virtual bool is_class (const vcl_string &cls) const
 Return true if the argument matches the string identifying the class or any parent class.
void describe (vcl_ostream &strm, int blanking=0) const
 output description to stream.
const char * get_name () const
void un_protect ()
 unprotect the object.
virtual void print (vcl_ostream &strm=vcl_cout) const
bool operator!= (vsol_spatial_object_2d const &obj)
vsol_box_2d_sptr get_bounding_box () const
double get_min_x () const
double get_max_x () const
double get_min_y () const
double get_max_y () const
virtual vsol_spatial_object_2dcast_to_spatial_object ()
 The same behavior than dynamic_cast<>.
virtual vsol_spatial_object_2d
const * 
cast_to_spatial_object () const
virtual vtol_topology_object * cast_to_topology_object ()
virtual vtol_topology_object
const * 
cast_to_topology_object () const
virtual vsol_spatial_object_2dcast_to_vsol_spatial_object ()
virtual vsol_spatial_object_2d
const * 
cast_to_vsol_spatial_object () const
virtual vsol_point_2dcast_to_point ()
virtual vsol_point_2d const * cast_to_point () const
virtual vsol_curve_2dcast_to_curve ()
virtual vsol_curve_2d const * cast_to_curve () const
virtual vsol_region_2dcast_to_region ()
virtual vsol_region_2d const * cast_to_region () const
void touch ()
unsigned long get_time_stamp () const
bool older (vul_timestamp const &t) const
bool older (vul_timestamp const *t) const
void ref ()
void unref ()
int get_references () const
bool is_referenced () const
int get_id () const
 get id of object.
void set_id (int i)
 set id of object.
void set_user_flag (unsigned int flag)
 set a flag for a spatial object; flag can be VSOL_FLAG[1-6].
bool get_user_flag (unsigned int flag)
 check if a flag is set for a spatial object; flag can be VSOL_FLAG[1-6].
void unset_user_flag (unsigned int flag)
 un-set a flag for a spatial object; flag can be VSOL_FLAG[1-6].
void set_tagged_union_flag ()
 set the flag used by TAGGED_UNION.
bool get_tagged_union_flag ()
 check if the flag used by TAGGED_UNION is set.
void unset_tagged_union_flag ()
 un-set the flag used by TAGGED_UNION.
int get_tag_id ()
void set_tag_id (int id)

Static Public Attributes

static const char * SpatialTypes []
static const float eps = 1.0e-3f

Protected Member Functions

void not_applicable (vcl_string const &message) const
void empty_bounding_box () const
 make the bounding box empty; often first step in bounding box calculation.
void set_bounding_box (vsol_box_2d_sptr const &box) const
 set the bounding box; to be used in bounding box calculation.
void set_bounding_box (double x, double y) const
 set the bounding box to a single point, discarding the old bounding box.
void add_to_bounding_box (double x, double y) const
 add a point to the bounding box and take the convex union.
void add_to_bounding_box (vsol_box_2d_sptr const &box) const
 set the existing bounding box to the convex union of it with the given box.
void grow_minmax_bounds (vsol_box_2d_sptr const &b) const
 grow to the largest dim. of this and box, i.e., take the convex union.
void check_update_bounding_box () const
 Test consistency of bound.

Protected Attributes

unsigned long timestamp_
unsigned int tag_
int id_

Static Protected Attributes

static int tagcount_ = 0

Private Attributes

vcl_vector
< vsol_spatial_object_2d_sptr > * 
storage_
 Set of objects that `this' contains.

Friends

vcl_ostream & operator<< (vcl_ostream &, vsol_spatial_object_2d const &)
vcl_ostream & operator<< (vcl_ostream &, vsol_spatial_object_2d const *)

Detailed Description

Definition at line 28 of file vsol_group_2d.h.


Member Enumeration Documentation

Enumerator:
SPATIAL_NO_TYPE 
TOPOLOGYOBJECT 
POINT 
CURVE 
REGION 
SPATIALGROUP 
VOLUME 
NUM_SPATIALOBJECT_TYPES 

Definition at line 66 of file vsol_spatial_object_2d.h.


Constructor & Destructor Documentation

vsol_group_2d::vsol_group_2d ( void  )

Default Constructor: group with no child.

Default Constructor: with no child.

Definition at line 15 of file vsol_group_2d.cxx.

vsol_group_2d::vsol_group_2d ( const vsol_group_2d other)

Copy constructor.

The objects of the group are not duplicated

Description: The objects of the group are not duplicated

Definition at line 24 of file vsol_group_2d.cxx.

vsol_group_2d::~vsol_group_2d ( ) [virtual]

Destructor.

The objects of the group are not deleted

Description: The objects of the group are not deleted

Definition at line 33 of file vsol_group_2d.cxx.


Member Function Documentation

void vsol_group_2d::add_object ( const vsol_spatial_object_2d_sptr new_object)

Add an object `new_object' to `this'.

Require: !is_child(new_object)

Definition at line 118 of file vsol_group_2d.cxx.

void vsol_spatial_object_2d::add_to_bounding_box ( double  x,
double  y 
) const [protected, inherited]

add a point to the bounding box and take the convex union.

This is a "const" method since the bounding box is a "mutable" data member: calculating the bounding box does not change the object.

Definition at line 79 of file vsol_spatial_object_2d.cxx.

void vsol_spatial_object_2d::add_to_bounding_box ( vsol_box_2d_sptr const &  box) const [protected, inherited]

set the existing bounding box to the convex union of it with the given box.

Definition at line 84 of file vsol_spatial_object_2d.cxx.

void vsol_group_2d::b_read ( vsl_b_istream is) [virtual]

Binary load self from stream.

Binary load self from stream (not typically used).

Reimplemented from vsol_spatial_object_2d.

Definition at line 263 of file vsol_group_2d.cxx.

void vsol_group_2d::b_write ( vsl_b_ostream os) const [virtual]

Binary save self to stream.

Reimplemented from vsol_spatial_object_2d.

Definition at line 186 of file vsol_group_2d.cxx.

virtual vsol_curve_2d* vsol_spatial_object_2d::cast_to_curve ( ) [inline, virtual, inherited]

Reimplemented in vsol_curve_2d.

Definition at line 180 of file vsol_spatial_object_2d.h.

virtual vsol_curve_2d const* vsol_spatial_object_2d::cast_to_curve ( ) const [inline, virtual, inherited]

Reimplemented in vsol_curve_2d.

Definition at line 181 of file vsol_spatial_object_2d.h.

virtual const vsol_group_2d* vsol_group_2d::cast_to_group ( void  ) const [inline, virtual]

The same behavior than dynamic_cast<>.

Needed because VXL is not compiled with -frtti :-(

Reimplemented from vsol_spatial_object_2d.

Definition at line 116 of file vsol_group_2d.h.

virtual vsol_group_2d* vsol_group_2d::cast_to_group ( void  ) [inline, virtual]

Reimplemented from vsol_spatial_object_2d.

Definition at line 117 of file vsol_group_2d.h.

virtual vsol_point_2d* vsol_spatial_object_2d::cast_to_point ( void  ) [inline, virtual, inherited]

Reimplemented in vsol_point_2d.

Definition at line 178 of file vsol_spatial_object_2d.h.

virtual vsol_point_2d const* vsol_spatial_object_2d::cast_to_point ( void  ) const [inline, virtual, inherited]

Reimplemented in vsol_point_2d, and vsol_point_2d.

Definition at line 179 of file vsol_spatial_object_2d.h.

virtual vsol_region_2d* vsol_spatial_object_2d::cast_to_region ( void  ) [inline, virtual, inherited]

Reimplemented in vsol_region_2d.

Definition at line 182 of file vsol_spatial_object_2d.h.

virtual vsol_region_2d const* vsol_spatial_object_2d::cast_to_region ( void  ) const [inline, virtual, inherited]

Reimplemented in vsol_region_2d, and vsol_region_2d.

Definition at line 183 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d* vsol_spatial_object_2d::cast_to_spatial_object ( ) [inline, virtual, inherited]

The same behavior than dynamic_cast<>.

Needed because VXL is not necessarily compiled with -frtti

Definition at line 170 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d const* vsol_spatial_object_2d::cast_to_spatial_object ( ) const [inline, virtual, inherited]

Definition at line 171 of file vsol_spatial_object_2d.h.

virtual vtol_topology_object* vsol_spatial_object_2d::cast_to_topology_object ( ) [inline, virtual, inherited]

Definition at line 173 of file vsol_spatial_object_2d.h.

virtual vtol_topology_object const* vsol_spatial_object_2d::cast_to_topology_object ( ) const [inline, virtual, inherited]

Definition at line 174 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d* vsol_spatial_object_2d::cast_to_vsol_spatial_object ( ) [inline, virtual, inherited]

Definition at line 176 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d const* vsol_spatial_object_2d::cast_to_vsol_spatial_object ( ) const [inline, virtual, inherited]

Definition at line 177 of file vsol_spatial_object_2d.h.

void vsol_spatial_object_2d::check_update_bounding_box ( ) const [protected, inherited]

Test consistency of bound.

Bounds Accessors:.

min_ and max_ are provided as methods on vsol_spatial_object_2d to be consistent with the previous interface Additional bounds accessors are available directly on vsol_box_2d. - JLM

Definition at line 97 of file vsol_spatial_object_2d.cxx.

vsol_spatial_object_2d * vsol_group_2d::clone ( void  ) const [virtual]

Clone `this': creation of a new object and initialization.

See Prototype pattern

Implements vsol_spatial_object_2d.

Definition at line 41 of file vsol_group_2d.cxx.

void vsol_group_2d::compute_bounding_box ( void  ) const [virtual]

Compute the bounding box of `this'.

REQUIRE: size()>0

Require: size()>0

Reimplemented from vsol_spatial_object_2d.

Definition at line 79 of file vsol_group_2d.cxx.

unsigned int vsol_group_2d::deep_size ( void  ) const

Return the number of objects of the group.

Definition at line 96 of file vsol_group_2d.cxx.

void vsol_group_2d::describe ( vcl_ostream &  strm,
int  blanking = 0 
) const [inline, virtual]

output description to stream.

Reimplemented from vsol_spatial_object_2d.

Definition at line 150 of file vsol_group_2d.h.

void vsol_spatial_object_2d::empty_bounding_box ( ) const [protected, inherited]

make the bounding box empty; often first step in bounding box calculation.

Definition at line 64 of file vsol_spatial_object_2d.cxx.

vsol_box_2d_sptr vsol_spatial_object_2d::get_bounding_box ( ) const [inline, inherited]

Definition at line 137 of file vsol_spatial_object_2d.h.

int vsol_flags_id::get_id ( ) const [inline, inherited]

get id of object.

Definition at line 52 of file vsol_flags_id.h.

double vsol_spatial_object_2d::get_max_x ( ) const [inherited]

Definition at line 118 of file vsol_spatial_object_2d.cxx.

double vsol_spatial_object_2d::get_max_y ( ) const [inherited]

Definition at line 128 of file vsol_spatial_object_2d.cxx.

double vsol_spatial_object_2d::get_min_x ( ) const [inherited]

Definition at line 113 of file vsol_spatial_object_2d.cxx.

double vsol_spatial_object_2d::get_min_y ( ) const [inherited]

Definition at line 123 of file vsol_spatial_object_2d.cxx.

const char * vsol_spatial_object_2d::get_name ( ) const [inherited]

Definition at line 40 of file vsol_spatial_object_2d.cxx.

int vsol_flags_id::get_tag_id ( ) [inline, inherited]

Definition at line 106 of file vsol_flags_id.h.

bool vsol_flags_id::get_tagged_union_flag ( ) [inline, inherited]

check if the flag used by TAGGED_UNION is set.

Definition at line 95 of file vsol_flags_id.h.

bool vsol_flags_id::get_user_flag ( unsigned int  flag) [inline, inherited]

check if a flag is set for a spatial object; flag can be VSOL_FLAG[1-6].

Definition at line 77 of file vsol_flags_id.h.

void vsol_spatial_object_2d::grow_minmax_bounds ( vsol_box_2d_sptr const &  b) const [inline, protected, inherited]

grow to the largest dim. of this and box, i.e., take the convex union.

Definition at line 160 of file vsol_spatial_object_2d.h.

virtual vcl_string vsol_group_2d::is_a ( ) const [inline, virtual]

Return a platform independent string identifying the class.

Implements vsol_spatial_object_2d.

Definition at line 143 of file vsol_group_2d.h.

bool vsol_group_2d::is_child ( const vsol_spatial_object_2d_sptr new_object) const

Is `new_object' a child (direct or not) of `this' ?.

Definition at line 147 of file vsol_group_2d.cxx.

virtual bool vsol_group_2d::is_class ( const vcl_string &  cls) const [inline, virtual]

Return true if the argument matches the string identifying the class or any parent class.

Definition at line 146 of file vsol_group_2d.h.

void vsol_spatial_object_2d::not_applicable ( vcl_string const &  message) const [inline, protected, inherited]

Definition at line 89 of file vsol_spatial_object_2d.h.

vsol_spatial_object_2d_sptr vsol_group_2d::object ( unsigned int  i) const

Return the object `i'.

REQUIRE: i>=0 and i<size()

Require: i>=0 and i<size()

Definition at line 53 of file vsol_group_2d.cxx.

bool vsol_group_2d::operator!= ( const vsol_group_2d o) const [inline]

Has `this' not the same number of elements and as other and not equal elements?.

Definition at line 126 of file vsol_group_2d.h.

bool vsol_spatial_object_2d::operator!= ( vsol_spatial_object_2d const &  obj) [inline, inherited]

Definition at line 133 of file vsol_spatial_object_2d.h.

bool vsol_group_2d::operator== ( const vsol_group_2d other) const [virtual]

Has `this' the same number of elements and as other and equal elements?.

Definition at line 161 of file vsol_group_2d.cxx.

bool vsol_group_2d::operator== ( const vsol_spatial_object_2d obj) const [virtual]

Reimplemented from vsol_spatial_object_2d.

Definition at line 176 of file vsol_group_2d.cxx.

virtual void vsol_spatial_object_2d::print ( vcl_ostream &  strm = vcl_cout) const [inline, virtual, inherited]

Definition at line 125 of file vsol_spatial_object_2d.h.

void vsol_group_2d::print_summary ( vcl_ostream &  os) const

Print an ascii summary to the stream.

Definition at line 350 of file vsol_group_2d.cxx.

void vsol_group_2d::remove_object ( unsigned int  i)

Remove object `i' of `this' (not delete it).

REQUIRE: i>=0 and i<size()

Require: i>=0 and i<size()

Definition at line 133 of file vsol_group_2d.cxx.

void vsol_spatial_object_2d::set_bounding_box ( vsol_box_2d_sptr const &  box) const [protected, inherited]

set the bounding box; to be used in bounding box calculation.

Definition at line 74 of file vsol_spatial_object_2d.cxx.

void vsol_spatial_object_2d::set_bounding_box ( double  x,
double  y 
) const [protected, inherited]

set the bounding box to a single point, discarding the old bounding box.

This is a "const" method since the bounding box is a "mutable" data member: calculating the bounding box does not change the object.

Definition at line 69 of file vsol_spatial_object_2d.cxx.

void vsol_flags_id::set_id ( int  i) [inline, inherited]

set id of object.

Definition at line 54 of file vsol_flags_id.h.

void vsol_flags_id::set_tag_id ( int  id) [inline, inherited]

Definition at line 111 of file vsol_flags_id.h.

void vsol_flags_id::set_tagged_union_flag ( ) [inline, inherited]

set the flag used by TAGGED_UNION.

Definition at line 89 of file vsol_flags_id.h.

void vsol_flags_id::set_user_flag ( unsigned int  flag) [inline, inherited]

set a flag for a spatial object; flag can be VSOL_FLAG[1-6].

Definition at line 71 of file vsol_flags_id.h.

unsigned int vsol_group_2d::size ( void  ) const [inline]

Return the number of direct children of the group.

Definition at line 86 of file vsol_group_2d.h.

vsol_spatial_object_2d::vsol_spatial_object_2d_type vsol_group_2d::spatial_type ( void  ) const [virtual]

Return the real type of a group. It is a SPATIALGROUP.

Implements vsol_spatial_object_2d.

Definition at line 71 of file vsol_group_2d.cxx.

void vsol_spatial_object_2d::un_protect ( ) [inline, inherited]

unprotect the object.

Definition at line 104 of file vsol_spatial_object_2d.h.

void vsol_flags_id::unset_tagged_union_flag ( ) [inline, inherited]

un-set the flag used by TAGGED_UNION.

Definition at line 101 of file vsol_flags_id.h.

void vsol_flags_id::unset_user_flag ( unsigned int  flag) [inline, inherited]

un-set a flag for a spatial object; flag can be VSOL_FLAG[1-6].

Definition at line 83 of file vsol_flags_id.h.

short vsol_group_2d::version ( ) const

Return IO version number;.

Reimplemented from vsol_spatial_object_2d.

Definition at line 344 of file vsol_group_2d.cxx.


Friends And Related Function Documentation

vcl_ostream& operator<< ( vcl_ostream &  strm,
vsol_spatial_object_2d const &  so 
) [friend, inherited]

Definition at line 190 of file vsol_spatial_object_2d.h.

vcl_ostream& operator<< ( vcl_ostream &  strm,
vsol_spatial_object_2d const *  so 
) [friend, inherited]

Definition at line 196 of file vsol_spatial_object_2d.h.


Member Data Documentation

const float vsol_spatial_object_2d::eps = 1.0e-3f [static, inherited]

Definition at line 79 of file vsol_spatial_object_2d.h.

int vsol_flags_id::id_ [protected, inherited]

Definition at line 39 of file vsol_flags_id.h.

const char * vsol_spatial_object_2d::SpatialTypes [static, inherited]
Initial value:
{
  "NO_TYPE             ",
  "TOPOLOGYOBJECT      ",
  "POINT               ",
  "CURVE               ",
  "REGION              ",
  "SPATIALGROUP        ",
  "NUM_SPATIALOBJECT_TYPES"
}

Definition at line 78 of file vsol_spatial_object_2d.h.

Set of objects that `this' contains.

Definition at line 36 of file vsol_group_2d.h.

unsigned int vsol_flags_id::tag_ [protected, inherited]

Definition at line 38 of file vsol_flags_id.h.

int vsol_flags_id::tagcount_ = 0 [static, protected, inherited]

Definition at line 40 of file vsol_flags_id.h.


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