OperatorBase< T1, T2 > Class Template Reference

The base class for constructing calculating operators. More...

#include <OperatorBase.hh>

List of all members.

Public Member Functions
	OperatorBase ()
virtual	~OperatorBase ()
void	SetInput (T1 InputObj)
void	SetInputP (T1 *InputObj)
T2	Put (UInt4 index=0)
UInt4	InputObjNumber ()
UInt4	OutputObjNumber ()
void	Clear ()
Protected Member Functions
T1 *	PutInput (UInt4 index=0)
void	SetOutput (T2 *OutputObj)

---

Detailed Description

template<class T1, class T2>
class OperatorBase< T1, T2 >

The base class for constructing calculating operators.

This class is the template base class for constructing calculating operators. The child class of this class should only have functionalities of some procedures for data-converter, analysis etc.

Some source data-objects are inputed into "InputVec" with SetInput( T1 ). Input source data-objects will be deleted by the destructor of this class. The contents of input source data-objects are extracted and analyzed by the child class of this class. The output object should be constructed in the child class and the output objects are installed into "OutputVec" with "SetOutput(T2*)". The output objects will be deleted by the destructor, but you should see the following comments.

The results of the operation can be obtained from "T2 Put(UInt4)". "Put(UInt4)" will return a data object, and the return objects can install data containers and the other operators. The original data objects held by OutputVec will be deleted by the destructor of this class, but "T2 Put(UInt4)" returns the copy of the results.

---

Constructor & Destructor Documentation

template<class T1 , class T2 >

OperatorBase< T1, T2 >::OperatorBase

(

)

Constructor.

template<class T1 , class T2 >

OperatorBase< T1, T2 >::~OperatorBase

(

)

[virtual]

Destructor. Delete all data objects, output objects. See the comments of "Put(Int4)" and "Duplicate(Int4)".

---

Member Function Documentation

template<class T1 , class T2 >

void OperatorBase< T1, T2 >::Clear

(

)

Clear the two data storage completely. All output-objects and the copies of input-objects are deleted.

template<class T1 , class T2 >

UInt4 OperatorBase< T1, T2 >::InputObjNumber

(

)

[inline]

Returns the size of InputVec. The return integer express the number of input objects.

template<class T1 , class T2 >

UInt4 OperatorBase< T1, T2 >::OutputObjNumber

(

)

[inline]

Returns the size of OutputVec. The return integer express the number of output objects.

template<class T1 , class T2 >

T2 OperatorBase< T1, T2 >::Put

(

UInt4

index = 0

)

Return the result data-object assigned to "index". If T2-type data container is not installed with "SetOutput(T2*)", a T2-type data container will be constructed in this method and returned. If the value of the argument is too large, this method will be return a T2-type data container whose content is empty.

template<class T1 , class T2 >

T1* OperatorBase< T1, T2 >::PutInput

(

UInt4

index = 0

)

[inline, protected]

Return the pointer of input data object assigned to "index". This method will be called from the child class.

template<class T1 , class T2 >

void OperatorBase< T1, T2 >::SetInputP

(

T1 *

InputObj

)

Set input object. The index number is given automatically. The input data objects will be copied to dynamical data objects and the copy will be installed to the data storage. The objects will be deleted by the destructor.

template<class T1 , class T2 >

void OperatorBase< T1, T2 >::SetOutput

(

T2 *

OutputObj

)

[protected]

Set the pointer of output data objects, these object will be deleted by the destructor. This method will be called from the child class.

---

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

• OperatorBase.hh
• OperatorBase.cc