lsst.pex::policy::PolicySource Class Reference

an abstract class representing a source of serialized Policy parameter data. More...

#include <PolicySource.h>

Inheritance diagram for lsst.pex::policy::PolicySource:

Public Types
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
	PolicySource (SupportedFormats::Ptr fmts=defaultFormats)
	create a Policy file that points a file with given path. More...
virtual	~PolicySource ()
	destroy the source More...
virtual const std::string &	getFormatName ()=0
	identifiers for the different supported formats More...
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...
virtual void	load (Policy &policy) const =0
	load the data from this Policy source into a Policy object More...
virtual void	load (Policy &policy)=0
	load the data from this Policy source into a Policy object More...

Static Public Member Functions
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...
Census
Provide a list of current Citizens
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...
callbackIDs
Set callback Ids. The old Id is returned
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...
callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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...

Static Public Attributes
static SupportedFormats::Ptr	defaultFormats
	returns true if the given string containing a content identifier indicates that it contains dictionary data. More...

Protected Attributes
SupportedFormats::Ptr	_formats

Detailed Description

an abstract class representing a source of serialized Policy parameter data.

This might be a file or a stream; sub-classes handle the different possibilities. This class can determine which format the data is in (which may involve reading the first few characters) and load it into a Policy.

Definition at line 53 of file PolicySource.h.

Member Typedef Documentation

memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

{ magicSentinel = 0xdeadbeef };  

Constructor & Destructor Documentation

PolicySource()

lsst.pex::policy::PolicySource::PolicySource ( SupportedFormats::Ptr  fmts = defaultFormats )

inline

create a Policy file that points a file with given path.

Parameters

fmts	the list of formats to support

Definition at line 60 of file PolicySource.h.

        : lsst::daf::base::Citizen(typeid(this)), _formats(fmts)
    {
        if (defaultFormats->size() == 0)
            SupportedFormats::initDefaultFormats(*defaultFormats);
    }

~PolicySource()

lsst.pex::policy::PolicySource::~PolicySource ( )

virtual

destroy the source

Definition at line 35 of file PolicySource.cc.

{ }

Member Function Documentation

census() [1/3]

int lsst::daf::base::Citizen::census ( int  , memId  startingMemId = 0  )

staticinherited

How many active Citizens are there?

Parameters

startingMemId

Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

  {
    if (startingMemId == 0) {  // easy
        ReadGuard guard(citizenLock);
        return _activeCitizens.size();
    }

    int n = 0;
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        if (cur->first->_CitizenId >= startingMemId) {
            n++;
        }
    }

    return n;
}

census() [2/3]

void lsst::daf::base::Citizen::census ( std::ostream &  stream, memId  startingMemId = 0  )

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

  {
    ReadGuard guard(citizenLock);

    std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());

    for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
         citizen != end; ++citizen) {
        if ((*citizen)->getId() >= startingMemId) {
            stream << (*citizen)->repr() << "\n";
        }
    }
}

census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                               {
    std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
    ReadGuard guard(citizenLock);
    vec->reserve(_activeCitizens.size());

    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        vec->push_back(dynamic_cast<Citizen const*>(cur->first));
    }

    std::sort(vec->begin(), vec->end(), cmpId);

    return vec;
}

getFormatName()

virtual const std::string& lsst.pex::policy::PolicySource::getFormatName ( )

pure virtual

identifiers for the different supported formats

Unknown and unsupported XML format Policy authoring format (PAF) Supported format but unknown determine the format that the data is stored in and return its format type identifier. Note that UNKNOWN will be returned if the format is supported–that is, the data can be read into a Policy object–but otherwise does not have a defined type identifier defined. This may cause the first few records of the source to be read.

Exceptions

IOError	if an error occurs while reading the first few characters of the source stream. return the name of the format that the data is stored in. This may cause the first few records of the source to be read.
IOError	if an error occurs while reading the first few characters of the source stream.

Implemented in lsst.pex::policy::PolicyFile, and lsst.pex::policy::PolicyString.

getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

{ return _CitizenId; }

getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

{ return _nextMemId(); }

hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                      {
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }
    for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }

    return false;
}

init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                         {
    volatile int dummy = 1;
    return dummy;
}

load() [1/2]

virtual void lsst.pex::policy::PolicySource::load ( Policy &  policy ) const

pure virtual

load the data from this Policy source into a Policy object

Parameters

policy

the policy object to load the data into

Exceptions

ParserException	if an error occurs while parsing the data
IOError	if an I/O error occurs while reading from the source stream.

Implemented in lsst.pex::policy::PolicyFile, lsst.pex::policy::DefaultPolicyFile, and lsst.pex::policy::PolicyString.

load() [2/2]

virtual void lsst.pex::policy::PolicySource::load ( Policy &  policy )

pure virtual

load the data from this Policy source into a Policy object

Parameters

policy

the policy object to load the data into

Exceptions

ParserException	if an error occurs while parsing the data
IOError	if an I/O error occurs while reading from the source stream.

Implemented in lsst.pex::policy::PolicyFile, and lsst.pex::policy::PolicyString.

markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void  )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                        {
    WriteGuard guard(citizenLock);
    _persistentCitizens[this] = _activeCitizens[this];
    _activeCitizens.erase(this);
}

repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                     {
    return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                      lsst::utils::demangleType(_typeName));
}

setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback  func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

  {
    Citizen::memCallback old = _corruptionCallback;
    _corruptionCallback = func;

    return old;
}

setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback  func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

  {
    Citizen::memCallback old = _deleteCallback;
    _deleteCallback = func;

    return old;
}

setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId  id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

  {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _deleteId;
    _deleteId = id;

    return oldId;
}

setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback  func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

  {
    Citizen::memNewCallback old = _newCallback;
    _newCallback = func;

    return old;
}

setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId  id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

  {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _newId;
    _newId = id;

    return oldId;
}

Member Data Documentation

_formats

SupportedFormats::Ptr lsst.pex::policy::PolicySource::_formats

protected

Definition at line 142 of file PolicySource.h.

defaultFormats

SupportedFormats::Ptr lsst.pex::policy::PolicySource::defaultFormats

static

returns true if the given string containing a content identifier indicates that it contains dictionary data.

Dictionary data has a content id of "<?cfg ... dictionary ?>" (where ... indicates the format); policy data has an id of "<?cfg ... policy ?>". a default set of formats

Definition at line 135 of file PolicySource.h.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pex_policy/18.1.0/include/lsst/pex/policy/PolicySource.h
• /j/snowflake/release/lsstsw/stack/Linux64/pex_policy/18.1.0/src/PolicySource.cc