Represents an individual feature within a Geojson definition. More...

#include <FeatureBase.hpp>

Inheritance diagram for geojson::FeatureBase:

Collaboration diagram for geojson::FeatureBase:

Public Member Functions
	FeatureBase (const FeatureBase &feature)
	Copy Constructor.

virtual	~FeatureBase ()
	Destructor.

FeatureType	get_type () const
	Retrieve an indicator as to what type of feature this is.

virtual void	add_origination_feature (FeatureBase *feature, bool connect=true)
	Set a separate feature as upstream from this instance.

virtual void	add_destination_feature (FeatureBase *feature, bool connect=true)
	Set a separate feature as destination from this instance.

virtual void	assign_neighbors ()
	Searches for features that share common destinations and links them.

virtual void	add_neighbor_feature (FeatureBase *feature, bool connect=true)
	Links this feature to a feature that shares a common destination.

virtual JSONProperty	get_property (const std::string &key) const
	Get a value from the set of properties.

virtual void	set_id (const std::string &new_id)
	Sets the ID for the Feature.

virtual JSONProperty	get (const std::string &key) const
	Get a foreign member value by name.

virtual void	set (const std::string &key, short value)
	Sets a foreign member value.

virtual void	set (const std::string &key, int value)
	Sets a foreign member value.

virtual void	set (const std::string &key, long value)
	Sets a foreign member value.

virtual void	set (const std::string &key, float value)
	Sets a foreign member value.

virtual void	set (const std::string &key, double value)
	Sets a foreign member value.

virtual void	set (const std::string &key, std::string value)
	Sets a foreign member value.

virtual void	set (const std::string &key, JSONProperty property)
	Sets a foreign member value.

virtual bool	has_key (const std::string &key)

virtual std::vector< std::string >	keys () const
	Retrieves a listing of all foreign member keys.

virtual std::vector< std::string >	property_keys () const
	Retireves a listing of all property keys.

virtual bool	has_property (std::string property_name) const

virtual std::vector< geojson::geometry >	get_geometry_collection () const
	Collects a collection of everything held within the inner geometry collection.

std::vector< double >	get_bounding_box () const
	Collects all values describing the bounds of this feature.

const PropertyMap &	get_properties () const

PropertyMap &	get_properties ()

std::string	get_id () const

std::string	get_id (std::string alt_id) const

int	get_number_of_destination_features ()

int	get_number_of_origination_features ()

int	get_number_of_neighbors ()

FeatureBase *	get_destination_feature (std::string id)

FeatureBase *	get_origination_feature (std::string id)

std::vector< FeatureBase * >	origination_features () const

std::vector< FeatureBase * >	destination_features () const

std::vector< FeatureBase * >	neighbor_features () const

int	get_origination_length ()

int	get_destination_length ()

int	get_contributor_count ()

bool	is_leaf ()

bool	is_root ()

template<class T >
T	geometry () const

::geojson::geometry	geometry () const

template<class T >
T	geometry (int index) const

virtual void	visit (FeatureVisitor &visitor)=0

bool	operator== (const FeatureBase &rhs)

bool	operator!= (const FeatureBase &other)

Protected Member Functions
	FeatureBase (std::string new_id="", PropertyMap new_properties=PropertyMap(), std::vector< double > new_bounding_box=std::vector< double >(), std::vector< FeatureBase * > origination_features=std::vector< FeatureBase * >(), std::vector< FeatureBase * > destination_features=std::vector< FeatureBase * >(), PropertyMap members=PropertyMap())
	Verbose constructor for the basic attributes of a feature.

virtual void	break_links ()

virtual void	remove_destination (FeatureBase *feature)

virtual void	remove_origination (FeatureBase *feature)

virtual void	remove_neighbor (FeatureBase *feature)

Protected Attributes
FeatureType	type

::geojson::geometry	geom

std::vector<::geojson::geometry >	geometry_collection

PropertyMap	properties

std::vector< double >	bounding_box

PropertyMap	foreign_members

std::string	id

std::vector< FeatureBase * >	origination

std::vector< FeatureBase * >	destination

std::vector< FeatureBase * >	neighbors

Friends
class	FeatureCollection

Detailed Description

Represents an individual feature within a Geojson definition.

Constructor & Destructor Documentation

◆ FeatureBase() [1/2]

geojson::FeatureBase::FeatureBase	(	std::string	new_id = "",
		PropertyMap	new_properties = PropertyMap(),
		std::vector< double >	new_bounding_box = std::vector<double>(),
		std::vector< FeatureBase * >	origination_features = std::vector<FeatureBase*>(),
		std::vector< FeatureBase * >	destination_features = std::vector<FeatureBase*>(),
		PropertyMap	members = PropertyMap() )

inlineprotected

Verbose constructor for the basic attributes of a feature.

Parameters

new_id	An id for the feature so that it may be referenced by name
new_properties	A mapping between a name for a property and its values
new_bounding_box	A list of double values describing the boundaries for a feature
origination_features	A series of raw pointers to features that lie upstream from this feature
destination_features	A series of raw pointers to features that lie downstream from this feature
members	A mapping of foreign members for the feature between the member name and its value

References add_destination_feature(), add_origination_feature(), bounding_box, destination_features(), foreign_members, origination_features(), and properties.

◆ FeatureBase() [2/2]

geojson::FeatureBase::FeatureBase ( const FeatureBase & feature )

inline

Copy Constructor.

References bounding_box, destination, destination_features(), geom, geometry_collection, geojson::GeometryCollection, get(), get_bounding_box(), get_geometry_collection(), get_id(), get_properties(), get_type(), keys(), origination, origination_features(), properties, set(), and type.

◆ ~FeatureBase()

virtual geojson::FeatureBase::~FeatureBase ( )

inlinevirtual

Destructor.

References break_links().

Member Function Documentation

◆ add_destination_feature()

virtual void geojson::FeatureBase::add_destination_feature	(	FeatureBase *	feature,
		bool	connect = true )

inlinevirtual

Set a separate feature as destination from this instance.

Parameters

feature	The feature to link to that is destination from this instance
connect	Whether or not to set this instance as upstream from the newly attached destination feature

References add_origination_feature(), geojson::contains(), and destination.

Referenced by FeatureBase(), and add_origination_feature().

◆ add_neighbor_feature()

virtual void geojson::FeatureBase::add_neighbor_feature	(	FeatureBase *	feature,
		bool	connect = true )

inlinevirtual

Links this feature to a feature that shares a common destination.

Parameters

feature	A feature with a common destination
connect	Whether or not this feature should be linked to the neighbor as well

References add_neighbor_feature(), geojson::contains(), and neighbors.

Referenced by add_neighbor_feature(), and assign_neighbors().

◆ add_origination_feature()

virtual void geojson::FeatureBase::add_origination_feature	(	FeatureBase *	feature,
		bool	connect = true )

inlinevirtual

Set a separate feature as upstream from this instance.

Parameters

feature	The feature to link to that is upstream from this instance
connect	Whether or not to set this instance as downsteam from the newly attached upstream feature

References add_destination_feature(), and origination.

Referenced by FeatureBase(), and add_destination_feature().

◆ assign_neighbors()

virtual void geojson::FeatureBase::assign_neighbors ( )

inlinevirtual

Searches for features that share common destinations and links them.

References add_neighbor_feature(), destination, and destination_features().

◆ break_links()

virtual void geojson::FeatureBase::break_links ( )

inlineprotectedvirtual

References destination, neighbors, and origination.

Referenced by ~FeatureBase().

◆ destination_features()

std::vector< FeatureBase * > geojson::FeatureBase::destination_features ( ) const

inline

References destination.

Referenced by FeatureBase(), FeatureBase(), and assign_neighbors().

◆ geometry() [1/3]

template<class T >

T geojson::FeatureBase::geometry ( ) const

inline

References geom, and geojson::get_geometry_type().

◆ geometry() [2/3]

::geojson::geometry geojson::FeatureBase::geometry ( ) const

inline

References geom.

◆ geometry() [3/3]

template<class T >

T geojson::FeatureBase::geometry ( int index ) const

inline

References geometry_collection, and geojson::get_geometry_type().

◆ get()

virtual JSONProperty geojson::FeatureBase::get ( const std::string & key ) const

inlinevirtual

Get a foreign member value by name.

Parameters

key	The name of the foreign member whose value to look for

Returns: The member value identified by the key

References foreign_members.

Referenced by FeatureBase(), and operator==().

◆ get_bounding_box()

std::vector< double > geojson::FeatureBase::get_bounding_box ( ) const

inline

Collects all values describing the bounds of this feature.

Returns: A collection of double values describing the bounds for this feature

References bounding_box.

Referenced by FeatureBase().

◆ get_contributor_count()

int geojson::FeatureBase::get_contributor_count ( )

inline

References geojson::contains(), and origination.

◆ get_destination_feature()

FeatureBase * geojson::FeatureBase::get_destination_feature ( std::string id )

inline

References destination.

◆ get_destination_length()

int geojson::FeatureBase::get_destination_length ( )

inline

References destination, and is_leaf().

◆ get_geometry_collection()

virtual std::vector< geojson::geometry > geojson::FeatureBase::get_geometry_collection ( ) const

inlinevirtual

Collects a collection of everything held within the inner geometry collection.

Returns: A collection of boost geometry objects

Exceptions

Runtime Error if this feature isn't a collection type

References geometry_collection, geojson::GeometryCollection, and type.

Referenced by geojson::CollectionFeature::CollectionFeature(), and FeatureBase().

◆ get_id() [1/2]

std::string geojson::FeatureBase::get_id ( ) const

inline

References id.

Referenced by FeatureBase(), and operator==().

◆ get_id() [2/2]

std::string geojson::FeatureBase::get_id ( std::string alt_id ) const

inline

References geojson::JSONProperty::as_string(), get_property(), and id.

◆ get_number_of_destination_features()

int geojson::FeatureBase::get_number_of_destination_features ( )

inline

References destination.

◆ get_number_of_neighbors()

int geojson::FeatureBase::get_number_of_neighbors ( )

inline

References neighbors.

◆ get_number_of_origination_features()

int geojson::FeatureBase::get_number_of_origination_features ( )

inline

References origination.

◆ get_origination_feature()

FeatureBase * geojson::FeatureBase::get_origination_feature ( std::string id )

inline

References origination.

◆ get_origination_length()

int geojson::FeatureBase::get_origination_length ( )

inline

References is_root(), and origination.

◆ get_properties() [1/2]

PropertyMap & geojson::FeatureBase::get_properties ( )

inline

References properties.

◆ get_properties() [2/2]

const PropertyMap & geojson::FeatureBase::get_properties ( ) const

inline

References properties.

Referenced by FeatureBase().

◆ get_property()

virtual JSONProperty geojson::FeatureBase::get_property ( const std::string & key ) const

inlinevirtual

Get a value from the set of properties.

Parameters

key	The name of the property to get

Returns: The property identified by the key

References properties.

Referenced by get_id(), and operator==().

◆ get_type()

FeatureType geojson::FeatureBase::get_type ( ) const

inline

Retrieve an indicator as to what type of feature this is.

Returns: The type of feature for this instance

References type.

Referenced by FeatureBase(), geojson::LineStringFeature::LineStringFeature(), geojson::MultiLineStringFeature::MultiLineStringFeature(), geojson::MultiPointFeature::MultiPointFeature(), geojson::PointFeature::PointFeature(), and operator==().

◆ has_key()

virtual bool geojson::FeatureBase::has_key ( const std::string & key )

inlinevirtual

References keys().

◆ has_property()

virtual bool geojson::FeatureBase::has_property ( std::string property_name ) const

inlinevirtual

References property_keys().

◆ is_leaf()

bool geojson::FeatureBase::is_leaf ( )

inline

References destination.

Referenced by get_destination_length().

◆ is_root()

bool geojson::FeatureBase::is_root ( )

inline

References origination.

Referenced by get_origination_length().

◆ keys()

virtual std::vector< std::string > geojson::FeatureBase::keys ( ) const

inlinevirtual

Retrieves a listing of all foreign member keys.

Returns: A list of all the names of foreign member values

References foreign_members.

Referenced by FeatureBase(), has_key(), and operator==().

◆ neighbor_features()

std::vector< FeatureBase * > geojson::FeatureBase::neighbor_features ( ) const

inline

References neighbors.

◆ operator!=()

bool geojson::FeatureBase::operator!= ( const FeatureBase & other )

inline

References operator==().

◆ operator==()

bool geojson::FeatureBase::operator== ( const FeatureBase & rhs )

inline

References bounding_box, geojson::contains(), destination, geom, geometry_collection, geojson::GeometryCollection, get(), get_id(), get_property(), get_type(), keys(), neighbors, origination, and property_keys().

Referenced by operator!=().

◆ origination_features()

std::vector< FeatureBase * > geojson::FeatureBase::origination_features ( ) const

inline

References origination.

Referenced by FeatureBase(), and FeatureBase().

◆ property_keys()

virtual std::vector< std::string > geojson::FeatureBase::property_keys ( ) const

inlinevirtual

Retireves a listing of all property keys.

Returns: A list of all the names of the properties for this feature

References properties, and property_keys().

Referenced by has_property(), operator==(), and property_keys().

◆ remove_destination()

virtual void geojson::FeatureBase::remove_destination ( FeatureBase * feature )

inlineprotectedvirtual

References destination.

◆ remove_neighbor()

virtual void geojson::FeatureBase::remove_neighbor ( FeatureBase * feature )

inlineprotectedvirtual

References neighbors.

◆ remove_origination()

virtual void geojson::FeatureBase::remove_origination ( FeatureBase * feature )

inlineprotectedvirtual

References origination.

◆ set() [1/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		double	value )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

◆ set() [2/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		float	value )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

◆ set() [3/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		int	value )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

◆ set() [4/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		JSONProperty	property )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

◆ set() [5/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		long	value )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

◆ set() [6/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		short	value )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

Referenced by FeatureBase().

◆ set() [7/7]

virtual void geojson::FeatureBase::set	(	const std::string &	key,
		std::string	value )

inlinevirtual

Sets a foreign member value.

Parameters

key	The name of the value to set
value	The value to set

References foreign_members.

◆ set_id()

virtual void geojson::FeatureBase::set_id ( const std::string & new_id )

inlinevirtual

Sets the ID for the Feature.

Parameters

new_id The new identifier for this feature

◆ visit()

virtual void geojson::FeatureBase::visit ( FeatureVisitor & visitor )

pure virtual

Implemented in geojson::CollectionFeature, geojson::LineStringFeature, geojson::MultiLineStringFeature, geojson::MultiPointFeature, geojson::MultiPolygonFeature, geojson::PointFeature, and geojson::PolygonFeature.

Friends And Related Symbol Documentation

◆ FeatureCollection

friend class FeatureCollection

friend

Member Data Documentation

◆ bounding_box

std::vector<double> geojson::FeatureBase::bounding_box

protected

Referenced by FeatureBase(), FeatureBase(), get_bounding_box(), and operator==().

◆ destination

std::vector<FeatureBase*> geojson::FeatureBase::destination

protected

Referenced by FeatureBase(), add_destination_feature(), assign_neighbors(), break_links(), destination_features(), get_destination_feature(), get_destination_length(), get_number_of_destination_features(), is_leaf(), operator==(), and remove_destination().

◆ foreign_members

PropertyMap geojson::FeatureBase::foreign_members

protected

Referenced by FeatureBase(), get(), keys(), set(), set(), set(), set(), set(), set(), and set().

◆ geom

::geojson::geometry geojson::FeatureBase::geom

protected

Referenced by FeatureBase(), geojson::LineStringFeature::LineStringFeature(), geojson::LineStringFeature::LineStringFeature(), geojson::MultiLineStringFeature::MultiLineStringFeature(), geojson::MultiLineStringFeature::MultiLineStringFeature(), geojson::MultiPointFeature::MultiPointFeature(), geojson::MultiPointFeature::MultiPointFeature(), geojson::MultiPolygonFeature::MultiPolygonFeature(), geojson::MultiPolygonFeature::MultiPolygonFeature(), geojson::PointFeature::PointFeature(), geojson::PointFeature::PointFeature(), geojson::PolygonFeature::PolygonFeature(), geometry(), geojson::LineStringFeature::geometry(), geojson::MultiLineStringFeature::geometry(), geojson::MultiPointFeature::geometry(), geojson::MultiPolygonFeature::geometry(), geojson::PointFeature::geometry(), geojson::PolygonFeature::geometry(), and operator==().

◆ geometry_collection

std::vector<::geojson::geometry> geojson::FeatureBase::geometry_collection

protected

Referenced by geojson::CollectionFeature::CollectionFeature(), geojson::CollectionFeature::CollectionFeature(), FeatureBase(), geometry(), get_geometry_collection(), and operator==().

◆ id

std::string geojson::FeatureBase::id

protected

Referenced by get_id(), and get_id().

◆ neighbors

std::vector<FeatureBase*> geojson::FeatureBase::neighbors

protected

Referenced by add_neighbor_feature(), break_links(), get_number_of_neighbors(), neighbor_features(), operator==(), and remove_neighbor().

◆ origination

std::vector<FeatureBase*> geojson::FeatureBase::origination

protected

Referenced by FeatureBase(), add_origination_feature(), break_links(), get_contributor_count(), get_number_of_origination_features(), get_origination_feature(), get_origination_length(), is_root(), operator==(), origination_features(), and remove_origination().

◆ properties

PropertyMap geojson::FeatureBase::properties

protected

Referenced by FeatureBase(), FeatureBase(), get_properties(), get_properties(), get_property(), and property_keys().

◆ type

FeatureType geojson::FeatureBase::type

protected

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

include/geojson/features/FeatureBase.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FeatureBase() [1/2]

◆ FeatureBase() [2/2]

◆ ~FeatureBase()

Member Function Documentation

◆ add_destination_feature()

◆ add_neighbor_feature()

◆ add_origination_feature()

◆ assign_neighbors()

◆ break_links()

◆ destination_features()

◆ geometry() [1/3]

◆ geometry() [2/3]

◆ geometry() [3/3]

◆ get()

◆ get_bounding_box()

◆ get_contributor_count()

◆ get_destination_feature()

◆ get_destination_length()

◆ get_geometry_collection()

◆ get_id() [1/2]

◆ get_id() [2/2]

◆ get_number_of_destination_features()

◆ get_number_of_neighbors()

◆ get_number_of_origination_features()

◆ get_origination_feature()

◆ get_origination_length()

◆ get_properties() [1/2]

◆ get_properties() [2/2]

◆ get_property()

◆ get_type()

◆ has_key()

◆ has_property()

◆ is_leaf()

◆ is_root()

◆ keys()

◆ neighbor_features()

◆ operator!=()

◆ operator==()

◆ origination_features()

◆ property_keys()

◆ remove_destination()

◆ remove_neighbor()

◆ remove_origination()

◆ set() [1/7]

◆ set() [2/7]

◆ set() [3/7]

◆ set() [4/7]

◆ set() [5/7]

◆ set() [6/7]

◆ set() [7/7]

◆ set_id()

◆ visit()

Friends And Related Symbol Documentation

◆ FeatureCollection

Member Data Documentation

◆ bounding_box

◆ destination

◆ foreign_members

◆ geom

◆ geometry_collection

◆ id

◆ neighbors

◆ origination

◆ properties

◆ type