lsst::afw::table::IdFactory Class Reference

A polymorphic functor base class for generating record IDs for a table. More...

#include <IdFactory.h>

Public Member Functions
virtual RecordId	operator() ()=0
	Return a new unique RecordId.
virtual void	notify (RecordId id)=0
	Notify the IdFactory that the given ID has been used and must not be returned by operator().
virtual std::shared_ptr< IdFactory >	clone () const =0
	Deep-copy the IdFactory.
	IdFactory ()=default
	IdFactory (IdFactory const &)=default
	IdFactory (IdFactory &&)=default
IdFactory &	operator= (IdFactory const &other)=delete
IdFactory &	operator= (IdFactory &&other)=delete
virtual	~IdFactory ()=default

Static Public Member Functions
static std::shared_ptr< IdFactory >	makeSimple ()
	Return a simple IdFactory that simply counts from 1.
static std::shared_ptr< IdFactory >	makeSource (RecordId expId, int reserved)
	Return an IdFactory that includes another, fixed ID in the higher-order bits.
static int	computeReservedFromMaxBits (int maxBits)
	Return the number to pass as the 'reserved' argument to makeSource for an exposure ID with the given maximum number of bits.

Detailed Description

A polymorphic functor base class for generating record IDs for a table.

The IDs produced by an IdFactory need not be sequential, but they must be unique, both with respect to the IDs it generates itself and those passed to it via the notify() member function. Valid IDs must be nonzero, as zero is used to indicate null in some contexts.

Definition at line 21 of file IdFactory.h.

Constructor & Destructor Documentation

IdFactory() [1/3]

lsst::afw::table::IdFactory::IdFactory ( )

default

IdFactory() [2/3]

lsst::afw::table::IdFactory::IdFactory ( IdFactory const & )

default

IdFactory() [3/3]

lsst::afw::table::IdFactory::IdFactory ( IdFactory && )

default

~IdFactory()

virtual lsst::afw::table::IdFactory::~IdFactory ( )

virtualdefault

Member Function Documentation

clone()

virtual std::shared_ptr< IdFactory > lsst::afw::table::IdFactory::clone ( ) const

pure virtual

Deep-copy the IdFactory.

computeReservedFromMaxBits()

static int lsst::afw::table::IdFactory::computeReservedFromMaxBits ( int maxBits )

inlinestatic

Return the number to pass as the 'reserved' argument to makeSource for an exposure ID with the given maximum number of bits.

Parameters

[in]

maxBits

The maximum number of bits an exposure ID can have.

Definition at line 57 of file IdFactory.h.

                                                       {
        // Subtract one for signed integers to avoid the sign bit.
        return sizeof(RecordId)*8 - std::is_signed<RecordId>::value - maxBits;
    }

makeSimple()

std::shared_ptr< IdFactory > lsst::afw::table::IdFactory::makeSimple ( )

static

Return a simple IdFactory that simply counts from 1.

This is used when an empty pointer is passed to the BaseTable constructor.

Definition at line 70 of file IdFactory.cc.

{ return std::make_shared<SimpleIdFactory>(); }

makeSource()

std::shared_ptr< IdFactory > lsst::afw::table::IdFactory::makeSource ( RecordId expId, int reserved )

static

Return an IdFactory that includes another, fixed ID in the higher-order bits.

Parameters

[in]	expId	ID to include in the upper bits via a bitwise OR.
[in]	reserved	How many bits to reserve for the part of the ID that is unique.

The final record ID will be:

(upper << reserved) | sequence

Definition at line 72 of file IdFactory.cc.

                                                                           {
    return std::make_shared<SourceIdFactory>(expId, reserved);
}

notify()

virtual void lsst::afw::table::IdFactory::notify ( RecordId id )

pure virtual

Notify the IdFactory that the given ID has been used and must not be returned by operator().

operator()()

virtual RecordId lsst::afw::table::IdFactory::operator() ( )

pure virtual

Return a new unique RecordId.

operator=() [1/2]

IdFactory & lsst::afw::table::IdFactory::operator= ( IdFactory && other )

delete

operator=() [2/2]

IdFactory & lsst::afw::table::IdFactory::operator= ( IdFactory const & other )

delete

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/table/IdFactory.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/table/IdFactory.cc