lsst.pex.policy  16.0+1
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
lsst::pex::policy::PolicyDestination Class Referenceabstract

a class representing a destination to serialize Policy parameter data to. More...

#include <PolicyDestination.h>

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

Public Types

typedef unsigned long memId
 
typedef memId(* memNewCallback) (const memId cid)
 
typedef memId(* memCallback) (const Citizen *ptr)
 

Public Member Functions

 PolicyDestination ()
 create a destination More...
 
virtual ~PolicyDestination ()
 release resource associated with the destination More...
 
virtual std::ostreamgetOutputStream ()=0
 return a stream that can be used to write the data to. More...
 
std::string repr () const
 
void markPersistent (void)
 
memId getId () const
 

Static Public Member Functions

static bool hasBeenCorrupted ()
 
static memId getNextMemId ()
 
static int init ()
 
static int census (int, memId startingMemId=0)
 
static void census (std::ostream &stream, memId startingMemId=0)
 
static const std::vector< const Citizen *> * census ()
 
static int census (int, memId startingMemId=0)
 
static void census (std::ostream &stream, memId startingMemId=0)
 
static const std::vector< const Citizen *> * census ()
 
static memId setNewCallbackId (memId id)
 
static memId setNewCallbackId (memId id)
 
static memId setDeleteCallbackId (memId id)
 
static memId setDeleteCallbackId (memId id)
 
static memNewCallback setNewCallback (memNewCallback func)
 
static memCallback setDeleteCallback (memCallback func)
 
static memCallback setCorruptionCallback (memCallback func)
 

Public Attributes

 magicSentinel
 

Protected Member Functions

 PolicyDestination (const PolicyDestination &that)
 create a copy of this destination 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

◆ PolicyDestination() [1/2]

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

create a destination

Definition at line 57 of file PolicyDestination.h.

◆ ~PolicyDestination()

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

release resource associated with the destination

Definition at line 35 of file PolicyDestination.cc.

◆ PolicyDestination() [2/2]

lsst::pex::policy::PolicyDestination::PolicyDestination ( const PolicyDestination that)
inlineprotected

create a copy of this destination

Definition at line 73 of file PolicyDestination.h.

Member Function Documentation

◆ getOutputStream()

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: