All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisResources Class CATEAnalysisGroup
Usage: you can derive this class.
public class CATEAnalysisGroup
Adaptor for CATISamGroup interface.
This adaptor provides some tools for implementing CATISamGroup.
This Adaptor should be used in BOA DataExtension.
- See also:
- CATISamGroup
Constructor and Destructor Index
- o
CATEAnalysisGroup()
-
- o
~CATEAnalysisGroup()
-
Method Index
- o
GetContent(CATSamValue,CATString,CATAnalysisEntityCollector*&)
- Gets a collection of objects defined by a particular category and position.
- o
GetGroupAvailableContents(int&,CATSamValue*&)
- Retrieves the list of the different contents of the group defined by their category.
- o
GetGroupAvailablePositions(CATSamValue,int&,CATString*&)
- Retrieves the list of the different contents of the group defined by their category and position.
- o
IsGroupOf(CATSamValue,CATString,boolean&)
- Tests if the group can return a collection of objects defined by a particular category and position.
- o
ReComputeContent(CATSamValue,CATString,int&,CATSamExplicitPtr*&,int*&)
- Tools for Get Content implementation.
- o
Update()
- Allows to update internal data.
Constructor and Destructor
o CATEAnalysisGroup
| public CATEAnalysisGroup( | ) |
-
o ~CATEAnalysisGroup
| public virtual ~CATEAnalysisGroup( | ) |
-
Methods
o GetContent
| public virtual GetContent( | const | iContent, |
| const | iPosition, |
| const | oCollector) |
-
Gets a collection of objects defined by a particular category and position.
Should be re-implemented if the group have no explicit view,
else just implement ReComputeContent .
- Parameters:
-
- iContent
- The category of the content.
- iPosition
- The position of the content.
- oCollector
- The Entity Collector.
- See also:
- CATAnalysisEntityCollector
o GetGroupAvailableContents
| public virtual GetGroupAvailableContents( | | oNumber, |
| const | oContents) |
-
Retrieves the list of the different contents of the group defined by their category.
Should be re-implemented.
- Parameters:
-
- oNumber
- The number of different categories.
- oContents[oNumber]
- A pointer to the table of categories.
o GetGroupAvailablePositions
| public virtual GetGroupAvailablePositions( | const | iContent, |
| | oNumber, |
| const | oPositions) |
-
Retrieves the list of the different contents of the group defined by their category and position.
Should be re-implemented.
- Parameters:
-
- iContent
- The category for which we are looking for different available positions.
- oNumber
- The number of different positions.
- oPositions[oNumber]
- A pointer to the table of positions.
o IsGroupOf
| public virtual IsGroupOf( | const | iContent, |
| const | iPosition, |
| | oRes) |
-
Tests if the group can return a collection of objects defined by a particular category and position.
Default implementation based on the previous methods.
- Parameters:
-
- iContent
- The category of the content.
- iPosition
- The position of the content.
- oRes
-
Legal values:
- TRUE if the group can return objects.
- FALSE otherwise.
o ReComputeContent
| protected virtual ReComputeContent( | const | iContent, |
| const | iPosition, |
| | oNbElem, |
| | oPtrList, |
| | oGlobalPositionsList) |
-
Tools for Get Content implementation.
Used if no Explicit view is managed. Should be re-implemented.
- Parameters:
-
- iContent
- The category of the content.
- iPosition
- The position of the content.
o Update
-
Allows to update internal data.
Should be re-implemented for your own data members.
This object is included in the file: CATEAnalysisGroup.h
If needed, your Imakefile.mk should include the module: CATAnalysisResources