Information required to identify a dataset. More...

#include <MD_DataIdentification.h>

Inheritance diagram for te::md::MD_DataIdentification:

Public Member Functions
void	addPointOfContact (CI_ResponsibleParty *p)
	Adds a point of contact to the resource. More...

MD_Identification *	clone () const
	Gets a copy of this object. More...

const std::string &	getAbstract () const
	Returns the resource abstract. More...

const CI_Citation *	getCitation () const
	Returns the citation for the metadata. More...

const boost::ptr_vector < CI_ResponsibleParty > &	getPointsOfContact () const
	Returns the resource points of contact. More...

te::md::MD_ProgressCode	getStatus () const
	Returns the resource status code. More...

	MD_DataIdentification (CI_Citation *cite, const std::string &abstract, MD_ProgressCode status, const std::string &lang)
	Constructor. More...

	~MD_DataIdentification ()
	Destructor. More...

Accessor methods
Methods used to get or set properties.
void	addLanguage (const std::string &lang)
	Adds a language used within the dataset. More...

const std::vector< std::string > &	getLanguages () const
	Returns the set of languages associated to the dataset. More...

void	addCharacterSet (MD_CharacterSetCode code)
	Adds a character coding standard in the dataset. More...

const std::vector < MD_CharacterSetCode > &	getCharsetCodes () const
	Returns a character coding standard in the dataset. More...

void	addTopicCategory (MD_TopicCategoryCode code)
	Adds a theme of the dataset. More...

const std::vector < MD_TopicCategoryCode > &	getTopicCategories () const
	Return the themes associated to the dataset. More...

void	addGeographicBBoxExt (const double &llx, const double &lly, const double &urx, const double &ury, bool isInside=true)
	Adds the spatial description of the dataset. More...

void	addGeographicBBoxExt (const te::gm::Envelope *bb, bool isInside=true)
	Adds the spatial description of the dataset. More...

const te::gm::Envelope &	getExtent () const
	Returns the set of extents for the dataset. More...

bool	dataIsCovered () const
	Returns true if the bounding polygon encompasses an area covered by the data or false if is an area where data is not present. More...

void	setSpatialRepType (te::md::MD_SpatialRepresentationTypeCode code)
	Sets the spatial representation type. More...

te::md::MD_SpatialRepresentationTypeCode	getSpatialRepTypeCode () const
	Returns the spatial representation type. More...

void	setScale (long d)
	Sets resource scale. The scale of a map or other cartographic object expressed as a fraction or ratio which relates unit distance on the map or other cartographic object to distance, measured in the same units, on the ground. More...

long	getScale () const
	Returns the scale information. If equal to 0 the denominator is not valid. More...

Protected Attributes
std::string	m_abstract

CI_Citation *	m_citation

boost::ptr_vector < CI_ResponsibleParty >	m_poc

te::md::MD_ProgressCode	m_status

Private Attributes
std::vector< MD_CharacterSetCode >	m_charSet

bool	m_dataIsCovered

te::gm::Envelope	m_extent

std::vector< std::string >	m_language

long	m_scale

te::md::MD_SpatialRepresentationTypeCode	m_spatialRepresentationType

std::vector< MD_TopicCategoryCode >	m_topicCategory

Detailed Description

Information required to identify a dataset.

Note: Only the mandatory elements for the core metadata are implemented.

Definition at line 52 of file MD_DataIdentification.h.

Constructor & Destructor Documentation

te::md::MD_DataIdentification::MD_DataIdentification	(	CI_Citation *	cite,
		const std::string &	abstract,
		MD_ProgressCode	status,
		const std::string &	lang
	)

Constructor.

Parameters

citation	Pointer to the citation to the resource. Class takes ownership. Do not pass null.
abstract	Brief narrative summary of the resource.
status	The development phase of the resource.
lang	A language used within the dataset. using standard ISO three-letter codes. Do not pass empty.

Definition at line 31 of file MD_DataIdentification.cpp.

References m_language.

te::md::MD_DataIdentification::~MD_DataIdentification ( )

Destructor.

Definition at line 40 of file MD_DataIdentification.cpp.

Member Function Documentation

void te::md::MD_DataIdentification::addCharacterSet ( MD_CharacterSetCode code )

Adds a character coding standard in the dataset.

Definition at line 57 of file MD_DataIdentification.cpp.

Referenced by clone().

void te::md::MD_DataIdentification::addGeographicBBoxExt	(	const double &	llx,
		const double &	lly,
		const double &	urx,
		const double &	ury,
		bool	isInside = `true`
	)

Adds the spatial description of the dataset.

Parameters

llx	Westernmost coordinate of the limit of the dataset extent, expressed in longitude in decimal degrees.
lly	Southernmost coordinate of the limit of the dataset extent, expressed in latitude in decimal degrees.
urx	Easternmost coordinate of the limit of the dataset extent, expressed in longitude in decimal degrees.
lly	Northernmost coordinate of the limit of the dataset extent, expressed in latitude in decimal degrees.
isInside	True if the bounding polygon encompasses an area covered by the data or false if an area where data is not present. Default true.

Definition at line 81 of file MD_DataIdentification.cpp.

Referenced by clone().

void te::md::MD_DataIdentification::addGeographicBBoxExt	(	const te::gm::Envelope *	bb,
		bool	isInside = `true`
	)

Adds the spatial description of the dataset.

Parameters

bbx	Pointer to the enclosing boounding box. Do not pass null.
isInside	True if the bounding polygon encompasses an area covered by the data or false if an area where data is not present. Default true.

Definition at line 90 of file MD_DataIdentification.cpp.

References te::gm::Envelope::getLowerLeftX(), te::gm::Envelope::getLowerLeftY(), te::gm::Envelope::getUpperRightX(), and te::gm::Envelope::getUpperRightY().

void te::md::MD_DataIdentification::addLanguage ( const std::string & lang )

Adds a language used within the dataset.

Parameters

lang	Language description using standard ISO three-letter codes. Do not pass empty string.

Definition at line 45 of file MD_DataIdentification.cpp.

void te::md::MD_Identification::addPointOfContact ( CI_ResponsibleParty * p )

inherited

Adds a point of contact to the resource.

Parameters

poc	Pointer to a responsible party. Class takes pointer ownership. Do not pass null.

Definition at line 67 of file MD_Identification.cpp.

void te::md::MD_DataIdentification::addTopicCategory ( MD_TopicCategoryCode code )

Adds a theme of the dataset.

Definition at line 69 of file MD_DataIdentification.cpp.

Referenced by clone().

te::md::MD_Identification * te::md::MD_DataIdentification::clone ( ) const

virtual

Gets a copy of this object.

Reimplemented from te::md::MD_Identification.

Definition at line 131 of file MD_DataIdentification.cpp.

References addCharacterSet(), addGeographicBBoxExt(), addTopicCategory(), and setSpatialRepType().

bool te::md::MD_DataIdentification::dataIsCovered ( ) const

Returns true if the bounding polygon encompasses an area covered by the data or false if is an area where data is not present.

const std::string & te::md::MD_Identification::getAbstract ( ) const

inherited

Returns the resource abstract.

Definition at line 55 of file MD_Identification.cpp.

const std::vector< te::md::MD_CharacterSetCode > & te::md::MD_DataIdentification::getCharsetCodes ( ) const

Returns a character coding standard in the dataset.

Definition at line 63 of file MD_DataIdentification.cpp.

Referenced by te::md::Save().

const te::md::CI_Citation * te::md::MD_Identification::getCitation ( ) const

inherited

Returns the citation for the metadata.

Definition at line 48 of file MD_Identification.cpp.

const te::gm::Envelope & te::md::MD_DataIdentification::getExtent ( ) const

Returns the set of extents for the dataset.

Definition at line 98 of file MD_DataIdentification.cpp.

Referenced by te::md::Save().

const std::vector< std::string > & te::md::MD_DataIdentification::getLanguages ( ) const

Returns the set of languages associated to the dataset.

Definition at line 51 of file MD_DataIdentification.cpp.

Referenced by te::md::Save().

const boost::ptr_vector< te::md::CI_ResponsibleParty > & te::md::MD_Identification::getPointsOfContact ( ) const

inherited

Returns the resource points of contact.

Definition at line 75 of file MD_Identification.cpp.

long te::md::MD_DataIdentification::getScale ( ) const

Returns the scale information. If equal to 0 the denominator is not valid.

Definition at line 126 of file MD_DataIdentification.cpp.

Referenced by te::md::Save().

te::md::MD_SpatialRepresentationTypeCode te::md::MD_DataIdentification::getSpatialRepTypeCode ( ) const

Returns the spatial representation type.

Definition at line 111 of file MD_DataIdentification.cpp.

Referenced by te::md::Save().

te::md::MD_ProgressCode te::md::MD_Identification::getStatus ( ) const

inherited

Returns the resource status code.

Definition at line 61 of file MD_Identification.cpp.

const std::vector< te::md::MD_TopicCategoryCode > & te::md::MD_DataIdentification::getTopicCategories ( ) const

Return the themes associated to the dataset.

Definition at line 75 of file MD_DataIdentification.cpp.

Referenced by te::md::Save().

void te::md::MD_DataIdentification::setScale ( long d )

Sets resource scale. The scale of a map or other cartographic object expressed as a fraction or ratio which relates unit distance on the map or other cartographic object to distance, measured in the same units, on the ground.

Parameters

d	The scale denominator. Do not pass <= 0;

Definition at line 118 of file MD_DataIdentification.cpp.

void te::md::MD_DataIdentification::setSpatialRepType ( te::md::MD_SpatialRepresentationTypeCode code )

Sets the spatial representation type.

Definition at line 105 of file MD_DataIdentification.cpp.

Referenced by clone().

Member Data Documentation

std::string te::md::MD_Identification::m_abstract

protectedinherited

Definition at line 92 of file MD_Identification.h.

std::vector<MD_CharacterSetCode> te::md::MD_DataIdentification::m_charSet

private

Definition at line 142 of file MD_DataIdentification.h.

CI_Citation* te::md::MD_Identification::m_citation

protectedinherited

Definition at line 91 of file MD_Identification.h.

Referenced by te::md::MD_Identification::MD_Identification().

bool te::md::MD_DataIdentification::m_dataIsCovered

private

Definition at line 145 of file MD_DataIdentification.h.

te::gm::Envelope te::md::MD_DataIdentification::m_extent

private

Definition at line 144 of file MD_DataIdentification.h.

std::vector<std::string> te::md::MD_DataIdentification::m_language

private

Definition at line 141 of file MD_DataIdentification.h.

Referenced by MD_DataIdentification().

boost::ptr_vector<CI_ResponsibleParty> te::md::MD_Identification::m_poc

protectedinherited

Definition at line 94 of file MD_Identification.h.

long te::md::MD_DataIdentification::m_scale

private

Definition at line 147 of file MD_DataIdentification.h.

te::md::MD_SpatialRepresentationTypeCode te::md::MD_DataIdentification::m_spatialRepresentationType

private

Definition at line 146 of file MD_DataIdentification.h.

te::md::MD_ProgressCode te::md::MD_Identification::m_status

protectedinherited

Definition at line 93 of file MD_Identification.h.

std::vector<MD_TopicCategoryCode> te::md::MD_DataIdentification::m_topicCategory

private

Definition at line 143 of file MD_DataIdentification.h.

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

C:/TL5_2015_release/terralib5/src/terralib/metadata/iso19115/MD_DataIdentification.h
C:/TL5_2015_release/terralib5/src/terralib/metadata/iso19115/MD_DataIdentification.cpp

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation