CommonAlignmentAlgorithm/interface/AlignmentUserVariablesIO.h

#ifndef AlignmentUserVariablesIO_H
#define AlignmentUserVariablesIO_H

#include<vector>

/// \class AlignmentUserVariablesIO
///
/// Abstract base class for I/O of AlignmentUserVariables.
/// Note that it is the caller's responsibility to delete objects created during reading.
///
///  $Date: 2006/11/30 09:56:03 $
///  $Revision: 1.3 $
///  $Author: flucke $ (at least last update...)

class Alignable;
class AlignmentUserVariables;

class AlignmentUserVariablesIO 
{

  protected:

  virtual ~AlignmentUserVariablesIO() {}

  /** open IO */
  virtual int open(const char* filename, int iteration, bool writemode) =0;

  /** close IO */
  virtual int close(void) =0;

  /** write AlignmentUserVariables of one Alignable */
  virtual int writeOne(Alignable* ali) =0;

  /** read AlignmentUserVariables of one Alignable,
      object should be created and has to be deleted */
  virtual AlignmentUserVariables* readOne(Alignable* ali, int& ierr) =0;

  /** write AlignmentUserVariables of many Alignables */
  int write(const std::vector<Alignable*>& alivec, bool validCheck);

  /** read AlignmentUserVariables of many Alignables (using readOne, so take care of memory!) */
  std::vector<AlignmentUserVariables*> read(const std::vector<Alignable*>& alivec, int& ierr);

};

#endif
Revision:	1.3
Committed:	Tue Dec 12 08:55:44 2006 UTC (18 years, 4 months ago) by flucke
Content type:	text/plain
Branch:	MAIN
CVS Tags:	CMSSW_1_3_0_SLC4_pre1, CMSSW_1_3_0_pre1, V01-00-00, V00-08-01
Changes since 1.2:	+16 -17 lines
Log Message:	remove misleading comments about ownership (and its unused infrastructure), add documentation
#	User	Rev	Content
1	fpschill	1.1	#ifndef AlignmentUserVariablesIO_H
2			#define AlignmentUserVariablesIO_H
3
4	flucke	1.3	#include<vector>
5	fpschill	1.1
6	flucke	1.3	/// \class AlignmentUserVariablesIO
7			///
8			/// Abstract base class for I/O of AlignmentUserVariables.
9			/// Note that it is the caller's responsibility to delete objects created during reading.
10			///
11			/// $Date: 2006/11/30 09:56:03 $
12			/// $Revision: 1.3 $
13			/// $Author: flucke $ (at least last update...)
14	fpschill	1.1
15	flucke	1.3	class Alignable;
16			class AlignmentUserVariables;
17	fpschill	1.1
18			class AlignmentUserVariablesIO
19			{
20
21			protected:
22
23	flucke	1.3	virtual ~AlignmentUserVariablesIO() {}
24	fpschill	1.1
25			/** open IO */
26	flucke	1.2	virtual int open(const char* filename, int iteration, bool writemode) =0;
27	fpschill	1.1
28			/** close IO */
29			virtual int close(void) =0;
30
31			/** write AlignmentUserVariables of one Alignable */
32			virtual int writeOne(Alignable* ali) =0;
33
34	flucke	1.3	/** read AlignmentUserVariables of one Alignable,
35			object should be created and has to be deleted */
36	fpschill	1.1	virtual AlignmentUserVariables* readOne(Alignable* ali, int& ierr) =0;
37
38			/** write AlignmentUserVariables of many Alignables */
39			int write(const std::vector<Alignable*>& alivec, bool validCheck);
40
41	flucke	1.3	/** read AlignmentUserVariables of many Alignables (using readOne, so take care of memory!) */
42			std::vector<AlignmentUserVariables> read(const std::vector<Alignable>& alivec, int& ierr);
43	fpschill	1.1
44			};
45
46			#endif