MultiPandoraApi class. More...

#include <MultiPandoraApi.h>

Static Public Member Functions
static const PandoraInstanceMap &	GetPandoraInstanceMap ()
	Get the pandora instance map. More...

static const pandora::Pandora *	GetPandoraInstance (const pandora::Pandora *const pPrimaryPandora, const unsigned int volumeId)
	Get the address of the pandora instance associated with a given primary pandora instance and volume id number. More...

static const PandoraInstanceList &	GetDaughterPandoraInstanceList (const pandora::Pandora *const pPrimaryPandora)
	Get the list of daughter pandora instances associated with a given primary pandora instance. More...

static const pandora::Pandora *	GetPrimaryPandoraInstance (const pandora::Pandora *const pDaughterPandora)
	Get the address of the primary pandora instance associated with a given daughter pandora instance. More...

static unsigned int	GetVolumeId (const pandora::Pandora *const pPandora)
	Get the volume id associated with a given pandora instance. More...

static void	AddPrimaryPandoraInstance (const pandora::Pandora *const pPrimaryPandora)
	Declare a new primary pandora instance and receive the relevant multi pandora book-keeping instance. More...

static void	AddDaughterPandoraInstance (const pandora::Pandora const pPrimaryPandora, const pandora::Pandora const pDaughterPandora)
	Add a pandora daughter instance, associated to a primary pandora instance. More...

static void	DeletePandoraInstances (const pandora::Pandora *const pPrimaryPandora)
	Delete all pandora instances associated with (and including) a specified primary pandora instance. More...

static void	SetVolumeId (const pandora::Pandora *const pPandora, const unsigned int volumeId)
	Set the volume id associated with a given pandora instance. More...

Static Private Attributes
static MultiPandoraApiImpl	m_multiPandoraApiImpl
	The multi pandora api implementation. More...

Detailed Description

MultiPandoraApi class.

Definition at line 30 of file MultiPandoraApi.h.

Member Function Documentation

void MultiPandoraApi::AddDaughterPandoraInstance	(	const pandora::Pandora *const	pPrimaryPandora,
		const pandora::Pandora *const	pDaughterPandora
	)

static

Add a pandora daughter instance, associated to a primary pandora instance.

Parameters

pPrimaryPandora	the address of the primary pandora instance
pDaughterPandora	the address of the daughter pandora instance

Definition at line 61 of file MultiPandoraApi.cc.

 {
     m_multiPandoraApiImpl.AddDaughterPandoraInstance(pPrimaryPandora, pDaughterPandora);
 }

void MultiPandoraApi::AddPrimaryPandoraInstance ( const pandora::Pandora *const pPrimaryPandora )

static

Declare a new primary pandora instance and receive the relevant multi pandora book-keeping instance.

Parameters

pPrimaryPandora the address of the primary pandora instance

Returns: the multipandora instance

Definition at line 54 of file MultiPandoraApi.cc.

 {
     m_multiPandoraApiImpl.AddPrimaryPandoraInstance(pPrimaryPandora);
 }

void MultiPandoraApi::DeletePandoraInstances ( const pandora::Pandora *const pPrimaryPandora )

static

Delete all pandora instances associated with (and including) a specified primary pandora instance.

Parameters

pPrimaryPandora the address of the primary pandora instance

Definition at line 68 of file MultiPandoraApi.cc.

 {
     m_multiPandoraApiImpl.DeletePandoraInstances(pPrimaryPandora);
 }

const PandoraInstanceList & MultiPandoraApi::GetDaughterPandoraInstanceList ( const pandora::Pandora *const pPrimaryPandora )

static

Get the list of daughter pandora instances associated with a given primary pandora instance.

Parameters

pPrimaryPandora the address of the primary pandora instance

Returns: the daughter pandora instance list

Definition at line 33 of file MultiPandoraApi.cc.

 {
     return m_multiPandoraApiImpl.GetDaughterPandoraInstanceList(pPrimaryPandora);
 }

const pandora::Pandora * MultiPandoraApi::GetPandoraInstance	(	const pandora::Pandora *const	pPrimaryPandora,
		const unsigned int	volumeId
	)

static

Get the address of the pandora instance associated with a given primary pandora instance and volume id number.

Parameters

pPrimaryPandora	the address of the primary pandora instance
volumeId	the volume identifier number

Returns: the address of the pandora instance

Definition at line 26 of file MultiPandoraApi.cc.

 {
     return m_multiPandoraApiImpl.GetPandoraInstance(pPrimaryPandora, volumeId);
 }

const PandoraInstanceMap & MultiPandoraApi::GetPandoraInstanceMap ( )

static

Get the pandora instance map.

Returns: the pandora instance map

Definition at line 19 of file MultiPandoraApi.cc.

 {
     return m_multiPandoraApiImpl.GetPandoraInstanceMap();
 }

const pandora::Pandora * MultiPandoraApi::GetPrimaryPandoraInstance ( const pandora::Pandora *const pDaughterPandora )

static

Get the address of the primary pandora instance associated with a given daughter pandora instance.

Parameters

pDaughterPandora the address of the daughter pandora instance

Returns: the address of the primary pandora instance

Definition at line 40 of file MultiPandoraApi.cc.

 {
     return m_multiPandoraApiImpl.GetPrimaryPandoraInstance(pDaughterPandora);
 }

unsigned int MultiPandoraApi::GetVolumeId ( const pandora::Pandora *const pPandora )

static

Get the volume id associated with a given pandora instance.

Parameters

pPandora the address of the pandora instance

Returns: the volume id

Definition at line 47 of file MultiPandoraApi.cc.

 {
     return m_multiPandoraApiImpl.GetVolumeId(pPandora);
 }

void MultiPandoraApi::SetVolumeId	(	const pandora::Pandora *const	pPandora,
		const unsigned int	volumeId
	)

static

Set the volume id associated with a given pandora instance.

Parameters

pPandora	the address of the pandora instance
volumeId	the volume id

Definition at line 75 of file MultiPandoraApi.cc.

 {
     m_multiPandoraApiImpl.SetVolumeId(pPandora, volumeId);
 }

Member Data Documentation

MultiPandoraApiImpl MultiPandoraApi::m_multiPandoraApiImpl

staticprivate

The multi pandora api implementation.

Definition at line 110 of file MultiPandoraApi.h.

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

Static Public Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation