Arxx::Rule Class Reference

#include <Merge.h>

List of all members.

---

Detailed Description

A class representing a matching rule in the merging process.

During the process of merging every item of the source library will be subjected to match against every rule in a rule vector sequentially.

Public Member Functions
	Rule (Arxx::Action Action)
	Rule (const Arxx::Rule &Rule)
virtual bool	bMatch (Arxx::Context &Context) const =0
	This function returns whether the current item matches in the context.
virtual void	vAct (Arxx::Context &Context) const
Arxx::Action	GetAction (Arxx::Context &Context) const
	This function is called by the merger whenever a rule is matched.
Private Attributes
Arxx::Action	m_Action

---

Constructor & Destructor Documentation

Arxx::Rule::Rule

(

Arxx::Action

Action

)

[inline]

Arxx::Rule::Rule

(

const Arxx::Rule &

Rule

)

[inline]

---

Member Function Documentation

virtual bool Arxx::Rule::bMatch

(

Arxx::Context &

Context

)

const [pure virtual]

This function returns whether the current item matches in the context.

Parameters:

Context

The current settings in the merging process.

This function is pure virtual and you will need to overwrite it in order to make your rules work. Depending on the output of this function the merger will act:

Returns:

true - The merger will call GetAction().

false - The merger will simply skip this rule and proceed to the next.

Arxx::Action Arxx::Rule::GetAction

(

Arxx::Context &

Context

)

const [inline]

This function is called by the merger whenever a rule is matched.

Parameters:

Context

The context in which the merger asks for the action.

This function serves a two-part objective. It has to call vAct in order to allow the application programmer to specify additional actions after the matching is done and it will return the m_Action member variable.

Here is the call graph for this function:

virtual void Arxx::Rule::vAct

(

Arxx::Context &

Context

)

const [inline, virtual]

---

Member Data Documentation

Arxx::Action Arxx::Rule::m_Action [private]

---

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

• Merge.h

---