cl_syoscb_compare_base Class Reference

Base class for all comapre algorithms. More...

Inheritance diagram for cl_syoscb_compare_base:

[legend]

Collaboration diagram for cl_syoscb_compare_base:

[legend]

List of all members.

Public Member Functions
virtual void	compare ()
	Compare API: This method is the compare algorithms public compare method.
virtual void	compare_do ()
	Compare API: Does the actual compare.
void	set_cfg (cl_syoscb_cfg cfg)
	Compare API: Passes the configuration object on to the compare algorithm for faster access.
cl_syoscb_cfg	get_cfg ()
	Compare API: Returns the configuration object
string	get_primary_queue_name ()
	Compare API: Gets the primary queue. Convinience method.
Protected Attributes
cl_syoscb_cfg	cfg
	Handle to the configuration.

---

Detailed Description

Base class for all comapre algorithms.

Definition at line 2 of file cl_syoscb_compare_base.svh.

---

Member Function Documentation

void cl_syoscb_compare_base::compare

(

)

[virtual]

Compare API: This method is the compare algorithms public compare method.

It is called when the compare algorithm is asked to do a compare. Typically, this method is used to check state variables etc. to compte if the compare shall be done or not. If so then do_compare() is called.

NOTE: This method must be implemted.

Reimplemented in cl_syoscb_compare_io, and cl_syoscb_compare_io.

Definition at line 39 of file cl_syoscb_compare_base.svh.

void cl_syoscb_compare_base::compare_do

(

)

[virtual]

Compare API: Does the actual compare.

NOTE: This method must be implemted.

Reimplemented in cl_syoscb_compare_io, and cl_syoscb_compare_io.

Definition at line 45 of file cl_syoscb_compare_base.svh.

---

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

• cl_syoscb_compare_base.svh