lsst::daf::persistence::LogicalLocation Class Reference

Class for logical location of a persisted Persistable instance. More...

#include <LogicalLocation.h>

Inheritance diagram for lsst::daf::persistence::LogicalLocation:

Public Types
typedef boost::shared_ptr < LogicalLocation >	Ptr
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
	LogicalLocation (std::string const &locString, boost::shared_ptr< dafBase::PropertySet const > additionalData=boost::shared_ptr< dafBase::PropertySet const >())
std::string const &	locString (void) const
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static void	setLocationMap (boost::shared_ptr< dafBase::PropertySet > map)
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Private Attributes
std::string	_locString
	The location string. More...

Static Private Attributes
static boost::shared_ptr < dafBase::PropertySet >	_map
	The logical-to-less-logical map. More...

Detailed Description

Class for logical location of a persisted Persistable instance.

Implemented as a minimal string representing a pathname or a database connection string. Interpreted by Storage subclasses.

Definition at line 60 of file LogicalLocation.h.

Member Typedef Documentation

typedef boost::shared_ptr<LogicalLocation> lsst::daf::persistence::LogicalLocation::Ptr

Definition at line 62 of file LogicalLocation.h.

Constructor & Destructor Documentation

lsst::daf::persistence::LogicalLocation::LogicalLocation	(	std::string const &	locString,
		boost::shared_ptr< dafBase::PropertySet const >	additionalData = boost::shared_ptr< dafBase::PropertySet const>()
	)

Constructor from string and additional data.

Definition at line 58 of file LogicalLocation.cc.

                                                                              :
    lsst::daf::base::Citizen(typeid(*this)), _locString() {
    boost::regex expr("(%.*?)\\((\\w+?)\\)");
    boost::sregex_iterator i = make_regex_iterator(locString, expr);
    boost::sregex_iterator last;
    pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                      "Input string: " + locString);
    while (i != boost::sregex_iterator()) {
        last = i;
        if ((*i).prefix().matched) {
            _locString += (*i).prefix().str();
        }
        std::string fmt = (*i).str(1);
        std::string key = (*i).str(2);
        pexLog::TTrace<5>("daf.persistence.LogicalLocation", "Key: " + key);
        if (_map && _map->exists(key)) {
            if (_map->typeOf(key) == typeid(int)) {
                int value = _map->getAsInt(key);
                pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                                  "Map Val: %d", value);
                if (fmt == "%") {
                    _locString += (boost::format("%1%") % value).str();
                }
                else {
                    _locString += (boost::format(fmt) % value).str();
                }
            }
            else {
                std::string value = _map->getAsString(key);
                pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                                  "Map Val: " + value);
                _locString += value;
            }
        }
        else if (additionalData && additionalData->exists(key)) {
            if (additionalData->typeOf(key) == typeid(int)) {
                int value = additionalData->getAsInt(key);
                pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                                  "Map Val: %d", value);
                if (fmt == "%") {
                    _locString += (boost::format("%1%") % value).str();
                }
                else {
                    _locString += (boost::format(fmt) % value).str();
                }
            }
            else {
                std::string value = additionalData->getAsString(key);
                pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                                  "Map Val: " + value);
                _locString += value;
            }
        }
        else {
            throw LSST_EXCEPT(pexExcept::RuntimeError,
                              "Unknown substitution: " + key);
        }
        ++i;
    }
    if (last == boost::sregex_iterator()) {
        _locString = locString;
        pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                          "Copy to: " + _locString);
    }
    else {
        _locString += (*last).suffix().str();
        pexLog::TTrace<5>("daf.persistence.LogicalLocation",
                          "Result: " + _locString);
    }
}

Member Function Documentation

std::string const & lsst::daf::persistence::LogicalLocation::locString

(

void

)

const

Accessor.

Definition at line 132 of file LogicalLocation.cc.

                                                                {
    return _locString;
}

void lsst::daf::persistence::LogicalLocation::setLocationMap ( boost::shared_ptr< dafBase::PropertySet >  map )

static

Set the logical-to-less-logical map.

Definition at line 138 of file LogicalLocation.cc.

                                                                          {
    dafBase::PersistentCitizenScope scope;
    if (map) {
        _map = map->deepCopy();
    } else {
        _map.reset();
    }
}

Member Data Documentation

std::string lsst::daf::persistence::LogicalLocation::_locString

private

The location string.

Definition at line 71 of file LogicalLocation.h.

dafBase::PropertySet::Ptr lsst::daf::persistence::LogicalLocation::_map

staticprivate

The logical-to-less-logical map.

Definition at line 72 of file LogicalLocation.h.

---

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

• /home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/include/lsst/daf/persistence/LogicalLocation.h
• /home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/LogicalLocation.cc