bdlt::CalendarCache_Entry Class Reference

#include <bdlt_calendarcache.h>

Detailed Description

This class defines the type of objects that are inserted into the calendar cache. Each entry contains a shared pointer to a read-only calendar and the time at which that calendar was loaded.

Note

Note that an explicit allocator is required to create an entry object.

See bdlt_calendarcache

Public Member Functions
	CalendarCache_Entry ()
	CalendarCache_Entry (Calendar *calendar, const Datetime &loadTime, bslma::Allocator *allocator)
	CalendarCache_Entry (const CalendarCache_Entry &original)
	~CalendarCache_Entry ()
CalendarCache_Entry &	operator= (const CalendarCache_Entry &rhs)
bsl::shared_ptr< const Calendar >	get () const
Datetime	loadTime () const

Constructor & Destructor Documentation

CalendarCache_Entry() [1/3]

bdlt::CalendarCache_Entry::CalendarCache_Entry

(

)

Create an empty cache entry object.

Note

Note that an empty cache entry is never actually inserted into the cache.

CalendarCache_Entry() [2/3]

bdlt::CalendarCache_Entry::CalendarCache_Entry	(	Calendar *	calendar,
		const Datetime &	loadTime,
		bslma::Allocator *	allocator
	)

Create a cache entry object for managing the specified calendar that was loaded at the specified loadTime using the specified allocator.

Precondition

The behavior is undefined unless calendar uses allocator to obtain memory.

CalendarCache_Entry() [3/3]

bdlt::CalendarCache_Entry::CalendarCache_Entry

(

const CalendarCache_Entry &

original

)

Create a cache entry object having the value of the specified original object.

~CalendarCache_Entry()

bdlt::CalendarCache_Entry::~CalendarCache_Entry

(

)

Destroy this cache entry object.

Member Function Documentation

get()

bsl::shared_ptr< const Calendar > bdlt::CalendarCache_Entry::get

(

)

const

Return a shared pointer providing non-modifiable access to the calendar referred to by this cache entry object.

loadTime()

Datetime bdlt::CalendarCache_Entry::loadTime

(

)

const

Return the time at which the calendar referred to by this cache entry object was loaded.

operator=()

CalendarCache_Entry & bdlt::CalendarCache_Entry::operator=

(

const CalendarCache_Entry &

rhs

)

Assign to this cache entry object the value of the specified rhs object, and return a reference providing modifiable access to this object.

---

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

• bdlt_calendarcache.h