mspass::utility::AttributeCrossReference Class Reference

Cross reference between external and internal names. More...

#include <AttributeCrossReference.h>

Public Member Functions
	AttributeCrossReference ()
	AttributeCrossReference (const std::string lines_to_parse)
	AttributeCrossReference (const std::list< std::string > &lines)
	AttributeCrossReference (const std::map< std::string, std::string > internal2external, const mspass::utility::MetadataList &mdlist)
	AttributeCrossReference (const AttributeCrossReference &parent)
std::string	internal (const std::string key) const
std::string	external (const std::string key) const
MDtype	type (const std::string key) const
AttributeCrossReference &	operator= (const AttributeCrossReference &parent)
int	size () const
void	put (const std::string intern, const std::string ext)
std::set< std::string >	internal_names () const
std::set< std::string >	external_names () const

Detailed Description

Cross reference between external and internal names.

Data formats commonly have a frozen namespace with which people are very familiar. An example is SAC where scripts commonly manipulate header attribute by a fixed set of names. For good reasons one may want to use a different naming convention internally in a piece of software that loads data using an external format but wishes to use a different set of names internally. This object simplifies the task of managing the differences in internal and external names

Constructor & Destructor Documentation

AttributeCrossReference() [1/5]

mspass::utility::AttributeCrossReference::AttributeCrossReference ( )

inline

Default constructor.

The default constructor is a pure placeholder that does nothing. Result is a null namespace mapper.

{};

AttributeCrossReference() [2/5]

mspass::utility::AttributeCrossReference::AttributeCrossReference

(

const std::string

lines_to_parse

)

Construct from a string.

This constructor assumes the string variable passed is a complete image of a set of (newline separated) lines defining the mapping. The format of each line is assumed to be: internal_name external_name type. As the names imply "internal_name" is the name to use internally and "external_name" is the foramt specific external name. The "type" variable is generic and should be one of the simple keywords real, int, string, or boolean.

Parameters

lines_to_parse

is the (multiline) string in the format described above.

Exceptions

MsPASSError

will be thrown for parsing errors.

AttributeCrossReference() [3/5]

mspass::utility::AttributeCrossReference::AttributeCrossReference

(

const std::list< std::string > &

lines

)

Construct from a list container.

This constructor is nearly identical to the single string with newline constructor. The list elements are expected to be the contents of each line (newline break) for the string version.

\lines list container with input lines in same format as that described above for single string constructor.

Exceptions

MsPASSError

will be thrown if there are parsing errors.

AttributeCrossReference() [4/5]

mspass::utility::AttributeCrossReference::AttributeCrossReference	(	const std::map< std::string, std::string >	internal2external,
		const mspass::utility::MetadataList &	mdlist
	)

Build for a set of STL containers.

This is lower level constructor that effectively builds this object from a set of components that are used to actually implement the concept.

Parameters

internal2external	is an associative array keyed by the internal name that defines external names linked to each internal name.
mdlist	is a MsPASS::MetadataList object defining the complete internal namespace.

AttributeCrossReference() [5/5]

mspass::utility::AttributeCrossReference::AttributeCrossReference

(

const AttributeCrossReference &

parent

)

Standard copy constructor.

                                           {
  itoe = parent.itoe;
  etoi = parent.etoi;
  imdtypemap = parent.imdtypemap;
}

Member Function Documentation

external()

string mspass::utility::AttributeCrossReference::external

(

const std::string

key

)

const

Get external name for attribute with internal name key.

                                                               {
  map<string, string>::const_iterator iptr;
  iptr = itoe.find(key);
  if (iptr == itoe.end())
    throw MsPASSError(string("AttribureCrossReference::external:  ") +
                      "Cannot find attribute " + key +
                      " in internal to external  namespace map");
  return (iptr->second);
}

external_names()

set< string > mspass::utility::AttributeCrossReference::external_names

(

)

const

Return the set of external names defined by this object.

Returns an std::set container of strings that are the external names defined by this object.

                                                          {
  map<string, string>::const_iterator mptr;
  set<string> keys;
  for (mptr = etoi.begin(); mptr != etoi.end(); ++mptr) {
    keys.insert(mptr->first);
  }
  return keys;
}

internal()

string mspass::utility::AttributeCrossReference::internal

(

const std::string

key

)

const

Get internal name for attribute with external name key.

                                                               {
  map<string, string>::const_iterator iptr;
  iptr = etoi.find(key);
  if (iptr == etoi.end())
    throw MsPASSError(string("AttribureCrossReference::internal:  ") +
                      "Cannot find attribute " + key +
                      " in external to internal namespace map");
  return (iptr->second);
}

internal_names()

set< string > mspass::utility::AttributeCrossReference::internal_names

(

)

const

Return the set of internal names defined by this object.

Returns an std::set container of strings that are the internal names defined by this object.

                                                          {
  map<string, string>::const_iterator mptr;
  set<string> keys;
  for (mptr = itoe.begin(); mptr != itoe.end(); ++mptr) {
    keys.insert(mptr->first);
  }
  return keys;
}

operator=()

AttributeCrossReference & mspass::utility::AttributeCrossReference::operator=

(

const AttributeCrossReference &

parent

)

Standard assignment operator.

                                                                        {
  if (this != &parent) {
    itoe = parent.itoe;
    etoi = parent.etoi;
    imdtypemap = parent.imdtypemap;
  }
  return (*this);
}

put()

void mspass::utility::AttributeCrossReference::put	(	const std::string	intern,
		const std::string	ext
	)

Add a new entry to the map.

This method is used to extend the namespace.

Parameters

intern	is the internal name
ext	is the external name to be added.

                                                                {
  itoe.insert(pair<string, string>(i, e));
  etoi.insert(pair<string, string>(e, i));
}

size()

int mspass::utility::AttributeCrossReference::size

(

)

const

Return number of entries in the cross reference map.

                                        {
  // Assume the two maps are the same size
  return (itoe.size());
}

type()

MDtype mspass::utility::AttributeCrossReference::type

(

const std::string

key

)

const

Get type information for attribute with internal name key.

                                                           {
  map<string, MDtype>::const_iterator iptr;
  iptr = imdtypemap.find(key);
  if (iptr == imdtypemap.end())
    throw MsPASSError(string("AttributeCrossReference::type:  ") +
                      "Cannot find attribute " + key + " in type definitions");
  return (iptr->second);
}

---

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

• /home/runner/work/mspass/mspass/cxx/include/mspass/utility/AttributeCrossReference.h
• /home/runner/work/mspass/mspass/cxx/src/lib/utility/AttributeCrossReference.cc