All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisBase Class CATAnalysisCollectorRoot
CATAnalysisCollectorRoot
Usage: you must use this class as is. You should never derive it.
public class CATAnalysisCollectorRoot
A collector is an object obtained by combining the
information of basic characteristics over several entities.
Constructor and Destructor Index
- o
CATAnalysisCollectorRoot()
- Default constructor.
- o
CATAnalysisCollectorRoot(CATAnalysisCollectorRoot&)
- Copy constructor.
- o
~CATAnalysisCollectorRoot()
- Destructor.
Method Index
- o
AddRef()
- Increment the reference count.
- o
Dump(CATListValCATUnicodeString*,int,int,int)
- Dumps the contents of the collector.
- o
Dump(int,int,int)
- Dumps the contents of the collector.
- o
GetContext(CATAnalysisExplicitParent&)
- Obtains the context Set or Entity to which this collector belongs.
- o
GetContextModelTag()
- Obtain Context model tag.
- o
GetEntities(char*&)
- Obtains the entities for which the collector has values.
- o
GetNbEntities(int&)
- Obtains the number of entities for which the collector has information.
- o
GetReferenceCount()
- Obtain the reference count.
- o
IsAttachedToModel()
- Indicates if this collector is attached to the model or not.
- o
IsStreamable()
- Obtains the Streamable state of this collector.
- o
IsUpToDate()
- Obtains the UpToDate state of this collector.
- o
Release()
- Decrement the reference count.
- o
RequestDelayedDestruction(CATBoolean)
- Requests the collector delayed destruction.
- o
SetAttachedToModel(CATBoolean,CATSamExplicitPtr,CATBoolean)
- Attaches or detaches this collector from the model.
- o
SetContext(CATAnalysisExplicitParent&,CATBoolean)
- Assigns the context Set or Entity to which this collector belongs.
- o
SetEntities(char*)
- Assigns the entities for which the collector has values (Only for CharacCollector).
- o
SetNbEntities(int)
- Sets the number of entities for which the collector has information (Only for CharacCollector).
- o
SetUpToDate(CATBoolean)
- Assigns the UpToDate state of this collector.
Constructor and Destructor
o CATAnalysisCollectorRoot
public CATAnalysisCollectorRoot( | ) |
-
Default constructor.
o CATAnalysisCollectorRoot
-
Copy constructor.
o ~CATAnalysisCollectorRoot
public virtual ~CATAnalysisCollectorRoot( | ) |
-
Destructor.
Methods
o AddRef
-
Increment the reference count.
- Returns:
- The reference count value.
o Dump
-
Dumps the contents of the collector.
- Parameters:
-
- oListOfString
- The List of CATUnicodeString.
- iIndent
- The indentation level (one level represents 3 spaces).
- iRecurse
- The number of recursion levels.
- iLoopSize
- The size of loops.
o Dump
public virtual void Dump( | int | iIndent | = 0, |
| int | iRecurse | = 1, |
| int | iLoopSize | = 10) const |
-
Dumps the contents of the collector.
- Parameters:
-
- iIndent
- The indentation level (one level represents 3 spaces).
- iRecurse
- The number of recursion levels.
- iLoopSize
- The size of loops.
o GetContext
-
Obtains the context Set or Entity to which this collector belongs.
- Parameters:
-
- oContext
- A reference to the explicit version of the context.
- See also:
- CATAnalysisExplicitParent
o GetContextModelTag
public inline const int& GetContextModelTag( | )const |
-
Obtain Context model tag.
Inline Method.
- Returns:
- Context model tag.
o GetEntities
public virtual HRESULT GetEntities( | const char*& | oEntityFlags) const |
-
Obtains the entities for which the collector has values.
- Parameters:
-
- oEntityFlags[NbEntities]
- A pointer to the table of entity flags indicating which entities
had their values collected.
o GetNbEntities
public virtual HRESULT GetNbEntities( | int& | oNbEntities) const |
-
Obtains the number of entities for which the collector has information.
- Parameters:
-
- oNbEntities
- The number of entities.
o GetReferenceCount
public inline const int& GetReferenceCount( | )const |
-
Obtain the reference count.
Inline Method.
- Returns:
- The reference count value.
o IsAttachedToModel
-
Indicates if this collector is attached to the model or not.
o IsStreamable
-
Obtains the Streamable state of this collector.
o IsUpToDate
-
Obtains the UpToDate state of this collector.
Inline Method.
o Release
public int Release( | )const |
-
Decrement the reference count.
- Returns:
- The reference count value.
o RequestDelayedDestruction
public inline void RequestDelayedDestruction( | CATBoolean | iRequestDestruction | = TRUE) |
-
Requests the collector delayed destruction.
Inline Method.
The collector will be destroyed as soon as this will be possible.
- Parameters:
-
- iRequestDestruction
- This parameter indicates the request for the collector deletion.
o SetAttachedToModel
public HRESULT SetAttachedToModel( | CATBoolean | iIsAttachedToModel, |
| CATSamExplicitPtr | iCharacteristic | = NULL, |
| CATBoolean | iDeleteCharacteristic | = FALSE) |
-
Attaches or detaches this collector from the model.
- Parameters:
-
- iIsAttachedToModel
- The CATBoolean indicating the required action.
- iCharacteristic
- The pointer to the basic characteristic to which this collector
is linked to.
It is only used when detaching and if it is NULL, then it will be searched for.
- iDeleteCharacteristic
- If the collector is to be detached, then this parameter indicates
if the basic characteristic must be deleted or not.
o SetContext
-
Assigns the context Set or Entity to which this collector belongs.
- Parameters:
-
- iContext
- A reference to the explicit version of the context.
- iAttachToModel
- Indicates if the collector should be attached to the explicit
model or not.
- See also:
- CATAnalysisExplicitParent
o SetEntities
public virtual HRESULT SetEntities( | const char* | iEntityFlags) |
-
Assigns the entities for which the collector has values (Only for CharacCollector).
- Parameters:
-
- iEntityFlags[NbEntities]
- A pointer to the table of entity flags indicating which entities
should have their values collected.
A copy of the contents of the table will be made.
- See also:
- CATAnalysisCharacCollector
o SetNbEntities
public virtual HRESULT SetNbEntities( | int | iNbEntities | = 0) |
-
Sets the number of entities for which the collector has information (Only for CharacCollector).
- Parameters:
-
- iNbEntities
- The number of entities.
If 0, then the number is deduced from the context and the definition.
- See also:
- CATAnalysisCharacCollector
o SetUpToDate
-
Assigns the UpToDate state of this collector.
Inline Method.
- Parameters:
-
- iIsUpToDate
- The UpToDate state.
This object is included in the file: CATAnalysisCollectorRoot.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit