lsst::afw::table::AliasMap Class Reference

Mapping class that holds aliases for a Schema. More...

#include <AliasMap.h>

Public Types
using	Iterator = std::map<std::string, std::string>::const_iterator
	An iterator over alias->target pairs.

Public Member Functions
	AliasMap ()
	AliasMap (AliasMap const &other)
	Deep-copy an AliasMap.
	AliasMap (AliasMap &&other)
AliasMap &	operator= (AliasMap const &)=default
AliasMap &	operator= (AliasMap &&)=default
	~AliasMap ()=default
Iterator	begin () const
	Return a iterator to the beginning of the map.
Iterator	end () const
	Return a iterator to one past the end of the map.
std::size_t	size () const
	Return the number of aliases.
bool	empty () const
	Return the true if there are no aliases.
std::string	apply (std::string const &name) const
	Apply any aliases that match the given field name and return a de-aliased name.
std::string	get (std::string const &alias) const
	Return the target of the given alias.
void	set (std::string const &alias, std::string const &target)
	Add an alias to the schema or replace an existing one.
bool	erase (std::string const &alias)
	Remove an alias from the schema if it is present.
bool	operator== (AliasMap const &other) const
	Equality comparison.
bool	operator!= (AliasMap const &other) const
std::size_t	hash_value () const noexcept
	Return a hash of this object.
bool	contains (AliasMap const &other) const
	Return true if all aliases in this are also in other (with the same targets).
std::shared_ptr< BaseTable >	getTable () const
void	setTable (std::shared_ptr< BaseTable > table)

Friends
class	Schema
class	SubSchema

Detailed Description

Mapping class that holds aliases for a Schema.

Aliases need not be complete, but they must match to the beginning of a field name to be useful. For example, if "a_b_c" is a true field name, "x_->a_b" is a valid alias that will cause "x_y_c" to map to "a_b_c", but "y_z->b_c" will not cause "a_y_z" to be matched.

Aliases are not checked to see if they match any existing fields, and if an alias has the same name as a field name, it will take precedence and hide the true field.

Unlike the other components of a Schema, aliases can be modified and removed, even after a Table has been constructed from the Schema.

AliasMaps are shared when Schemas are copy-constructed, but can be separated manually by calling Schema::disconnectAliases() or Schema::setAliasMap(). In addition, the AliasMap is deep-copied when used to construct a Table (or Catalog).

In order to allow Tables to react to changes in aliases (which may be used to define cached Keys held by the table, as in SourceTable's "slots" mechanism), an AliasMap that is part of a Schema held by a Table will hold a pointer to that Table, and call BaseTable::handleAliasChanges() when its aliases are set or removed.

Definition at line 36 of file AliasMap.h.

Member Typedef Documentation

Iterator

using lsst::afw::table::AliasMap::Iterator = std::map<std::string, std::string>::const_iterator

An iterator over alias->target pairs.

Definition at line 57 of file AliasMap.h.

Constructor & Destructor Documentation

AliasMap() [1/3]

lsst::afw::table::AliasMap::AliasMap ( )

inline

Definition at line 41 of file AliasMap.h.

: _internal(), _table() {}

AliasMap() [2/3]

lsst::afw::table::AliasMap::AliasMap ( AliasMap const & other )

inline

Deep-copy an AliasMap.

The new AliasMap will not be linked to any tables, even if other is.

Definition at line 48 of file AliasMap.h.

: _internal(other._internal), _table() {}

AliasMap() [3/3]

lsst::afw::table::AliasMap::AliasMap ( AliasMap && other )

inline

Definition at line 50 of file AliasMap.h.

: AliasMap(other) {}

~AliasMap()

lsst::afw::table::AliasMap::~AliasMap ( )

default

Member Function Documentation

apply()

std::string lsst::afw::table::AliasMap::apply

(

std::string const &

name

)

const

Apply any aliases that match the given field name and return a de-aliased name.

Given a string that starts with any alias in the map, this returns a string with the part of the string that matches the alias replaced by that alias's target. The longest such alias is used.

For example:

m = AliasMap();
m.set("q", "a");
m.set("q1", "b");
assert(m.apply("q3") == "a3");
assert(m.apply("q12") == "b2");

Definition at line 67 of file AliasMap.cc.

                                                     {
    std::string result(name);
    _apply(result);
    return result;
}

begin()

Iterator lsst::afw::table::AliasMap::begin ( ) const

inline

Return a iterator to the beginning of the map.

Definition at line 60 of file AliasMap.h.

{ return _internal.begin(); }

contains()

bool lsst::afw::table::AliasMap::contains

(

AliasMap const &

other

)

const

Return true if all aliases in this are also in other (with the same targets).

Definition at line 111 of file AliasMap.cc.

                                                   {
    return std::includes(begin(), end(), other.begin(), other.end());
}

empty()

bool lsst::afw::table::AliasMap::empty ( ) const

inline

Return the true if there are no aliases.

Definition at line 69 of file AliasMap.h.

{ return _internal.empty(); }

end()

Iterator lsst::afw::table::AliasMap::end ( ) const

inline

Return a iterator to one past the end of the map.

Definition at line 63 of file AliasMap.h.

{ return _internal.end(); }

erase()

bool lsst::afw::table::AliasMap::erase

(

std::string const &

alias

)

Remove an alias from the schema if it is present.

Returns

True if an alias was erased, and false if no such alias was found.

Definition at line 90 of file AliasMap.cc.

                                           {
    bool result = _internal.erase(alias);
    auto table = _table.lock();
    if (table) {
        table->handleAliasChange(alias);
    }
    return result;
}

get()

std::string lsst::afw::table::AliasMap::get

(

std::string const &

alias

)

const

Return the target of the given alias.

Unlike apply(), this will not return partial matches.

Exceptions

pex::exceptions::NotFoundError

if no alias with the given name exists

Definition at line 73 of file AliasMap.cc.

                                                   {
    Iterator i = _internal.find(name);
    if (i == _internal.end()) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("Alias '%s' not found") % name).str());
    }
    return i->second;
}

getTable()

std::shared_ptr< BaseTable > lsst::afw::table::AliasMap::getTable ( ) const

inline

Definition at line 121 of file AliasMap.h.

{ return _table.lock(); }

hash_value()

std::size_t lsst::afw::table::AliasMap::hash_value ( ) const

noexcept

Return a hash of this object.

Definition at line 101 of file AliasMap.cc.

                                              {
    // Warning: this algorithm will be invalid if _internal is replaced by an unsorted map
    // Completely arbitrary seed
    std::size_t result = 42;
    for (const auto& entry : _internal) {
        result = cpputils::hashCombine(result, entry.first, entry.second);
    }
    return result;
}

operator!=()

bool lsst::afw::table::AliasMap::operator!= ( AliasMap const & other ) const

inline

Definition at line 112 of file AliasMap.h.

{ return !(other == *this); }

operator=() [1/2]

AliasMap & lsst::afw::table::AliasMap::operator= ( AliasMap && )

default

operator=() [2/2]

AliasMap & lsst::afw::table::AliasMap::operator= ( AliasMap const & )

default

operator==()

bool lsst::afw::table::AliasMap::operator==

(

AliasMap const &

other

)

const

Equality comparison.

Definition at line 99 of file AliasMap.cc.

{ return _internal == other._internal; }

set()

void lsst::afw::table::AliasMap::set	(	std::string const &	alias,
		std::string const &	target )

Add an alias to the schema or replace an existing one.

Definition at line 82 of file AliasMap.cc.

                                                                  {
    _internal[alias] = target;
    auto table = _table.lock();
    if (table) {
        table->handleAliasChange(alias);
    }
}

setTable()

void lsst::afw::table::AliasMap::setTable ( std::shared_ptr< BaseTable > table )

inline

Definition at line 122 of file AliasMap.h.

{ _table = table; }

size()

std::size_t lsst::afw::table::AliasMap::size ( ) const

inline

Return the number of aliases.

Definition at line 66 of file AliasMap.h.

{ return _internal.size(); }

Friends And Related Symbol Documentation

Schema

friend class Schema

friend

Definition at line 125 of file AliasMap.h.

SubSchema

friend class SubSchema

friend

Definition at line 126 of file AliasMap.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/table/AliasMap.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/src/table/AliasMap.cc