te::md::MD_DataIdentification Class Reference

Information required to identify a dataset. More...

#include <MD_DataIdentification.h>

Inheritance diagram for te::md::MD_DataIdentification:
te::md::MD_Identification

Public Member Functions

void addPointOfContact (CI_ResponsibleParty *p)
 Adds a point of contact to the resource. More...
 
MD_Identificationclone () const
 Gets a copy of this object. More...
 
const std::string & getAbstract () const
 Returns the resource abstract. More...
 
const CI_CitationgetCitation () 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::EnvelopegetExtent () 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_Citationm_citation
 
boost::ptr_vector< CI_ResponsiblePartym_poc
 
te::md::MD_ProgressCode m_status
 

Private Attributes

std::vector< MD_CharacterSetCodem_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_TopicCategoryCodem_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
citationPointer to the citation to the resource. Class takes ownership. Do not pass null.
abstractBrief narrative summary of the resource.
statusThe development phase of the resource.
langA language used within the dataset. using standard ISO three-letter codes. Do not pass empty.
te::md::MD_DataIdentification::~MD_DataIdentification ( )

Destructor.

Member Function Documentation

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

Adds a character coding standard in the dataset.

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
llxWesternmost coordinate of the limit of the dataset extent, expressed in longitude in decimal degrees.
llySouthernmost coordinate of the limit of the dataset extent, expressed in latitude in decimal degrees.
urxEasternmost coordinate of the limit of the dataset extent, expressed in longitude in decimal degrees.
llyNorthernmost coordinate of the limit of the dataset extent, expressed in latitude in decimal degrees.
isInsideTrue if the bounding polygon encompasses an area covered by the data or false if an area where data is not present. Default true.
void te::md::MD_DataIdentification::addGeographicBBoxExt ( const te::gm::Envelope bb,
bool  isInside = true 
)

Adds the spatial description of the dataset.

Parameters
bbxPointer to the enclosing boounding box. Do not pass null.
isInsideTrue if the bounding polygon encompasses an area covered by the data or false if an area where data is not present. Default true.
void te::md::MD_DataIdentification::addLanguage ( const std::string &  lang)

Adds a language used within the dataset.

Parameters
langLanguage description using standard ISO three-letter codes. Do not pass empty string.
void te::md::MD_Identification::addPointOfContact ( CI_ResponsibleParty p)
inherited

Adds a point of contact to the resource.

Parameters
pocPointer to a responsible party. Class takes pointer ownership. Do not pass null.
void te::md::MD_DataIdentification::addTopicCategory ( MD_TopicCategoryCode  code)

Adds a theme of the dataset.

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

Gets a copy of this object.

Reimplemented from te::md::MD_Identification.

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.

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

Returns a character coding standard in the dataset.

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

Returns the citation for the metadata.

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

Returns the set of extents for the dataset.

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

Returns the set of languages associated to the dataset.

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

Returns the resource points of contact.

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

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

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

Returns the spatial representation type.

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

Returns the resource status code.

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

Return the themes associated to the dataset.

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
dThe scale denominator. Do not pass <= 0;
void te::md::MD_DataIdentification::setSpatialRepType ( te::md::MD_SpatialRepresentationTypeCode  code)

Sets the spatial representation type.

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.

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.

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 file: