| # Gaudi Framework, version v23r1 |

Home |  | Generated: Wed Feb 29 2012

Public Types | Public Member Functions

# IPartitionControl Class Reference

Create / access partitions. More...

`#include <GaudiKernel/IPartitionControl.h>`

Inheritance diagram for IPartitionControl:
[legend]
Collaboration diagram for IPartitionControl:
[legend]

List of all members.

## Public Types
enum | { PARTITION_NOT_PRESENT = 2, PARTITION_EXISTS = 4, NO_ACTIVE_PARTITION = 6 }
## Public Member Functions
| DeclareInterfaceID (IPartitionControl, 1, 0)
| InterfaceID.
virtual StatusCode | create (const std::string &name, const std::string &type)=0
| Create a partition object. The name identifies the partition uniquely.
virtual StatusCode | create (const std::string &name, const std::string &type, IInterface *&pPartition)=0
| Create a partition object. The name identifies the partition uniquely.
virtual StatusCode | drop (const std::string &name)=0
| Drop a partition object. The name identifies the partition uniquely.
virtual StatusCode | drop (IInterface *pPartition)=0
| Drop a partition object. The name identifies the partition uniquely.
virtual StatusCode | activate (const std::string &name)=0
| Activate a partition object. The name identifies the partition uniquely.
virtual StatusCode | activate (IInterface *pPartition)=0
| Activate a partition object.
virtual StatusCode | get (const std::string &name, IInterface *&pPartition) const =0
| Access a partition object. The name identifies the partition uniquely.
virtual StatusCode | activePartition (std::string &name, IInterface *&pPartition) const =0
| Access the active partition object.

## Detailed Description

Create / access partitions.

Partitioning is used to switch between different instances of multi-services like it is used e.g. in the event buffer tampering.

Example code: =============

Switch between buffers for data processing. Use this technique to populate e.g. different datastores in order to later compare the different results.

SmartIF<IPartitionControl> partCtrl(eventSvc()); if ( partCtrl.isValid() ) { if ( partCtrl.activate("Partition_1").isSuccess() ) { SmartDataPtr mcparts(eventSvc(), "MC/Particles"); .... work with particles from buffer "Partition 1" all data registered by code here will go to "Partition 2" } if ( partCtrl.activate("Partition_2").isSuccess() ) { SmartDataPtr mcparts(eventSvc(), "MC/Particles"); .... work with particles from buffer "Partition 2" they are NOT they same as those in buffer 1 all data registered by code here will go to "Partition 2" } }

The access to the underlying service is also possible.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Be careful: This usage MAY NOT MODIFY e.g. the datastore by adding additional objects! This should solely by used for analysis after buffer tampering. In particular with "data on demand" this can easily have unexpected results.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

SmartIF<IPartitionControl> partCtrl(eventSvc()); if ( partCtrl ) { IInterface* ptr = 0; if ( partCtrl->get("Partition 1", ptr).isSuccess() ) { SmartIF<IDataProviderSvc> partition(ptr); // Now we can work directly with this partition // There is no additional dispathing in the "eventSvc()". SmartDataPtr mcparts(partition, "MC/Particles"); if ( mcparts ) { } } }

Author:
  Markus Frank

Version:
  1.0

Definition at line 67 of file IPartitionControl.h.

## Member Enumeration Documentation

anonymous enum

Enumerator:

  PARTITION_NOT_PRESENT |
  PARTITION_EXISTS |
  NO_ACTIVE_PARTITION |

Definition at line 178 of file IPartitionControl.h.

           {  PARTITION_NOT_PRESENT = 2,
              PARTITION_EXISTS = 4,
              NO_ACTIVE_PARTITION = 6
      };

## Member Function Documentation

virtual StatusCode IPartitionControl::activate | ( | const std::string & | name ) | `[pure virtual]`

Activate a partition object. The name identifies the partition uniquely.

Access an existing partition object. Preferred call. The activation of a partition does not change the state of the partition. It only means that any call issued to the corresponding multi-service will be redirected to the this partition - typically a service implementing the same interfaces as the multi-service.

Parameters:

  name | [IN] Partition name

Returns:
  Status code indicating failure or success.

virtual StatusCode IPartitionControl::activate | ( | IInterface * | pPartition ) | `[pure virtual]`

Activate a partition object.

Access an existing partition object. The activation of a partition does not change the state of the partition. It only means that any call issued to the corresponding multi-service will be redirected to the this partition - typically a service implementing the same interfaces as the multi-service.

If the interface pointer is invalid, IInterface::NO_INTERFACE is returned.

Parameters:

  pPartition | [IN] Pointer to the partition.

Returns:
  Status code indicating failure or success.

Implemented in PartitionSwitchAlg, and PartitionSwitchTool.

virtual StatusCode IPartitionControl::activePartition | ( | std::string & | name,
|  | IInterface *& | pPartition
| ) |  | const`[pure virtual]`

Access the active partition object.

Access the active partition object.

Parameters:

  name | [OUT] Partition name
  pPartition | [OUT] Location to store the pointer to the partition.

Returns:
  Status code indicating failure or success.

Implemented in PartitionSwitchAlg, and PartitionSwitchTool.

virtual StatusCode IPartitionControl::create | ( | const std::string & | name,
|  | const std::string & | type
| ) |  | `[pure virtual]`

Create a partition object. The name identifies the partition uniquely.

Create a new partition. If the partition exists already the existing object is returned. In this event the return code is PARTITION_EXISTS. The partition type typically contains all the information necessary to access the corresponding service, typically a pair "<service-type>/<service name>"

Parameters:

  name | [IN] Partition name
  type | [IN] Partition type

Returns:
  Status code indicating failure or success.

virtual StatusCode IPartitionControl::create | ( | const std::string & | name,
|  | const std::string & | type,
|  | IInterface *& | pPartition
| ) |  | `[pure virtual]`

Create a partition object. The name identifies the partition uniquely.

Create a new partition. If the partition exists already the existing object is returned. In this event the return code is PARTITION_EXISTS. The partition type typically contains all the information necessary to access the corresponding service, typically a pair "<service-type>/<service name>"

Parameters:

  name | [IN] Partition name
  type | [IN] Partition type
  pPartition | [OUT] Reference to the created/existing partition

Returns:
  Status code indicating failure or success.

IPartitionControl::DeclareInterfaceID | ( | IPartitionControl | ,
|  | 1 | ,
|  | 0 |
| ) |  |

InterfaceID.

virtual StatusCode IPartitionControl::drop | ( | IInterface * | pPartition ) | `[pure virtual]`

Drop a partition object. The name identifies the partition uniquely.

Remove a partition object. If the partition object does not exists, the return code is PARTITION_NOT_PRESENT. The partition may not be used anymore after this call. If the interface pointer is invalid, IInterface::NO_INTERFACE is returned.

Parameters:

  pPartition | [IN] Reference to existing partition

Returns:
  Status code indicating failure or success.

Implemented in PartitionSwitchAlg, and PartitionSwitchTool.

virtual StatusCode IPartitionControl::drop | ( | const std::string & | name ) | `[pure virtual]`

Drop a partition object. The name identifies the partition uniquely.

Remove a partition object. If the partition object does not exists, the return code is PARTITION_NOT_PRESENT. The partition may not be used anymore after this call.

Parameters:

  name | [IN] Partition name

Returns:
  Status code indicating failure or success.

virtual StatusCode IPartitionControl::get | ( | const std::string & | name,
|  | IInterface *& | pPartition
| ) |  | const`[pure virtual]`

Access a partition object. The name identifies the partition uniquely.

Access an existing partition object.

Parameters:

  name | [IN] Partition name
  pPartition | [IN] Location to store the pointer to the partition.

Returns:
  Status code indicating failure or success.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r1/GaudiKernel/GaudiKernel/IPartitionControl.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines