LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Protected Attributes | List of all members
lsst::pex::policy::PolicyStreamDestination Class Reference

#include <PolicyStreamDestination.h>

Inheritance diagram for lsst::pex::policy::PolicyStreamDestination:
lsst::pex::policy::PolicyDestination lsst::daf::base::Citizen lsst::pex::policy::PolicyStringDestination

Public Types

typedef boost::shared_ptr
< std::ostream > 
StreamPtr
 
- 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

 PolicyStreamDestination (StreamPtr ostrm)
 
virtual ~PolicyStreamDestination ()
 
virtual std::ostream & getOutputStream ()
 
- Public Member Functions inherited from lsst::pex::policy::PolicyDestination
 PolicyDestination ()
 
virtual ~PolicyDestination ()
 
- Public Member Functions inherited from lsst::daf::base::Citizen
 Citizen (const std::type_info &)
 
 Citizen (Citizen const &)
 
 ~Citizen ()
 
Citizenoperator= (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...
 

Protected Attributes

StreamPtr _ostrm
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from lsst::pex::policy::PolicyDestination
 PolicyDestination (const PolicyDestination &that)
 

Detailed Description

a generic stream destination for policy data

Definition at line 49 of file PolicyStreamDestination.h.

Member Typedef Documentation

typedef boost::shared_ptr<std::ostream> lsst::pex::policy::PolicyStreamDestination::StreamPtr

Definition at line 52 of file PolicyStreamDestination.h.

Constructor & Destructor Documentation

lsst::pex::policy::PolicyStreamDestination::PolicyStreamDestination ( PolicyStreamDestination::StreamPtr  ostrm)

create the destination

Definition at line 35 of file PolicyStreamDestination.cc.

lsst::pex::policy::PolicyStreamDestination::~PolicyStreamDestination ( )
virtual

release resource associated with the destination

Definition at line 38 of file PolicyStreamDestination.cc.

38 { }

Member Function Documentation

std::ostream & lsst::pex::policy::PolicyStreamDestination::getOutputStream ( )
virtual

return a stream that can be used to write the data to.

Implements lsst::pex::policy::PolicyDestination.

Definition at line 40 of file PolicyStreamDestination.cc.

40  {
41  return *_ostrm;
42 }

Member Data Documentation

StreamPtr lsst::pex::policy::PolicyStreamDestination::_ostrm
protected

Definition at line 70 of file PolicyStreamDestination.h.


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