LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Member Functions | Protected Member Functions | List of all members
lsst::pex.policy::PolicyDestination Class Referenceabstract

#include <PolicyDestination.h>

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

Public Member Functions

 PolicyDestination ()
 
virtual ~PolicyDestination ()
 
virtual std::ostream & getOutputStream ()=0
 
- 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 Member Functions

 PolicyDestination (const PolicyDestination &that)
 

Additional Inherited Members

- 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)
 
- 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...
 

Detailed Description

a class representing a destination to serialize Policy parameter data to. This might be a file, a string, or a stream; sub-classes handle the different possibilities. This class has no control over the format going to the destination; this is a matter for the PolicyWriter, which can take a PolicyDestination as a constructor input.

Definition at line 51 of file PolicyDestination.h.

Constructor & Destructor Documentation

lsst::pex.policy::PolicyDestination::PolicyDestination ( )
inline

create a destination

Definition at line 57 of file PolicyDestination.h.

57 : lsst::daf::base::Citizen(typeid(this)) { }
Citizen is a class that should be among all LSST classes base classes, and handles basic memory manag...
Definition: Citizen.h:56
lsst::pex.policy::PolicyDestination::~PolicyDestination ( )
virtual

release resource associated with the destination

Definition at line 35 of file PolicyDestination.cc.

35 { }
lsst::pex.policy::PolicyDestination::PolicyDestination ( const PolicyDestination that)
inlineprotected

create a copy of this destination

Definition at line 73 of file PolicyDestination.h.

74  : lsst::daf::base::Citizen(typeid(this)) { }
Citizen is a class that should be among all LSST classes base classes, and handles basic memory manag...
Definition: Citizen.h:56

Member Function Documentation

virtual std::ostream& lsst::pex.policy::PolicyDestination::getOutputStream ( )
pure virtual

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

Implemented in lsst::pex.policy::PolicyStreamDestination.


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