All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisBase Class CATAnalysisExplicitParent
CATAnalysisBase.CATAnalysisExplicitData
|
+---CATAnalysisBase.CATAnalysisExplicitChild
|
+---CATAnalysisExplicitParent
Usage: you must use this class as is. You should never derive it.
public class CATAnalysisExplicitParent
Field model parent.
This object is used to provide services common to all objects of the field model
which can be parents.
- See also:
- CATAnalysisExplicitChild
Constructor and Destructor Index
- o
CATAnalysisExplicitParent()
- Default constructor.
- o
CATAnalysisExplicitParent(CATAnalysisExplicitData&)
- Copy constructor.
- o
CATAnalysisExplicitParent(CATAnalysisExplicitParent&)
- Copy constructor.
Method Index
- o
AddAssemblyChild(CATAnalysisExplicitParent&)
- Adds one child to the current field model object.
- o
AddChild(CATAnalysisExplicitChild&)
- Adds one child to the current field model object.
- o
AddChildren(CATAnalysisExplicitList&)
- Adds several children to the current field model object.
- o
DeleteAll()
- Delete all CharacCollector under the current field model object.
- o
DeleteAllEntityCollector()
- Delete all EntityCollector under the current field model object.
- o
DeleteCharacCollector(CATAnalysisCharacCollector*&)
- Delete a CharacCollector under the current field model object.
- o
DeleteEntityCollector(CATAnalysisEntityCollector*&)
- Delete an EntityCollector under the current field model object.
- o
FindCharacCollector(CATAnalysisCharacCollector*,CATAnalysisExplicitCharac&)
- Finds in the current parent the explicit characteristic pointing to the collector iCharacCollector.
- o
FindCharacCollector(CATSamPhysicalType,CATSamCharacVersion&,CATString&,int,CATAnalysisCharacCollector*&,int,char* const,CATSamPhysicalType,int)
- Finds in the current parent the collector characteristic corresponding to a definition.
- o
FindEntityCollector(CATAnalysisEntityCollector*,CATAnalysisExplicitCharac&)
- Finds in the current parent the explicit characteristic pointing to the collector iEntityCollector.
- o
FindEntityCollector(CATSamValue&,CATString&,CATAnalysisEntityCollector*&)
- Finds in the current parent the collector characteristic corresponding to a definition.
- o
GetApplyBy(int&,CATSamExplicitPtr*&)
- Obtains the array of pointers to the apply-by.
- o
GetApplyBy(int&,CATSamExplicitPtr*&,CATSamPosition*&,int*&)
- Obtains the array of pointers to the apply-by, the array of apply types and
the array of apply numbers.
- o
GetApplyByList(CATAnalysisExplicitList&)
- Obtains the apply-by list.
- o
GetCategory(CATSamValue&)
- Obtains the category of the object.
- o
GetChildOfType(CATSamPhysicalType&,CATAnalysisExplicitChild&)
- Obtains the first child of a given PhysicalType.
- o
GetChildrenList(CATAnalysisExplicitList&)
- Obtains the list of children.
- o
GetChildrenList(CATAnalysisExplicitListUsr&,CATSamCompareType,void*,CATBoolean,CATBoolean)
- Obtains the recursive list of children using optional filter.
- o
GetPointedObject(CATAnalysisExplicitParent&)
- Gets the pointed parent if proxi status.
- o
GetUserName(char*(&))
- Retrieves the user name.
- o
GetUserNumber(int&)
- Retrieves a user number.
- o
IsActivated()
- Returns the activity status.
- o
IsPointedByProxy()
- Returns the pointed by proxy status.
- o
IsProxy()
- Returns the proxy status.
- o
RemoveChild(CATAnalysisExplicitChild&)
- Removes one child from the current field model object.
- o
RemoveChildren(CATAnalysisExplicitList&)
- Removes several children from the current field model object.
- o
SetUserName(char*)
- Assigns a user name.
- o
SetUserNumber(int)
- Assigns a user number.
- o
operator =(CATAnalysisExplicitData&)
- Assignment operator.
- o
operator =(CATAnalysisExplicitParent&)
- Assignment operator.
Constructor and Destructor
o CATAnalysisExplicitParent
public CATAnalysisExplicitParent( | ) |
-
Default constructor.
o CATAnalysisExplicitParent
-
Copy constructor.
- See also:
- CATAnalysisExplicitData
o CATAnalysisExplicitParent
-
Copy constructor.
Methods
o AddAssemblyChild
-
Adds one child to the current field model object.
- Parameters:
-
- iChild
- The child to be added.
Note :
This method must be used if iChild and the current parent are not defined in the same field model.
In addition the current field must must be in an assembly context.
o AddChild
-
Adds one child to the current field model object.
- Parameters:
-
- iChild
- The child to be added.
Note :
- A set can only be the child of other sets but not of entities.
- The child must be in same field model as the parent.
- See also:
- CATAnalysisExplicitChild
o AddChildren
-
Adds several children to the current field model object.
- Parameters:
-
- iChildren
- The list of children to be added.
Note :
- A set can only be the child of other sets but not of entities.
- Each child must be in same field model as the parent.
- See also:
- CATAnalysisExplicitList
o DeleteAll
-
Delete all CharacCollector under the current field model object.
- See also:
- CATAnalysisCharacCollector
o DeleteAllEntityCollector
public HRESULT DeleteAllEntityCollector( | ) |
-
Delete all EntityCollector under the current field model object.
- See also:
- CATAnalysisEntityCollector
o DeleteCharacCollector
-
Delete a CharacCollector under the current field model object.
- Parameters:
-
- iCharacCollector
- A pointer to the CATAnalysisCharacCollector to be deleted.
- See also:
- CATAnalysisCharacCollector
o DeleteEntityCollector
-
Delete an EntityCollector under the current field model object.
- Parameters:
-
- iEntityCollector
- A pointer to the CATAnalysisEntityCollector to be deleted.
- See also:
- CATAnalysisEntityCollector
o FindCharacCollector
-
Finds in the current parent the explicit characteristic pointing to the collector iCharacCollector.
- Parameters:
-
- iCharacCollector
- The instance of CATAnalysisCharacCollector.
- oCharac
- A reference to the explicit characteristic.
NULL_exp if it was not found.
- See also:
- CATAnalysisExplicitCharac
o FindCharacCollector
-
Finds in the current parent the collector characteristic corresponding to a definition.
- Parameters:
-
- iPhysicalType
- The physical type.
- iVersion
- A pointer to the version information (a CATSamCharacVersion object).
- iPosition
- A pointer to the position type identifier.
- iNumOccurrence
- The number of the occurrence.
- oCollector
- A pointer to the collector characteristic if it was found.
NULL if it was not found.
- iEntityFlagsNumber
- The size of the table iEntityFlags
- iEntityFlags[iEntityFlagsNumber]
- A pointer to the table of entity flags indicating which entities
had their values collected.
- iEntityPhysicalType
- The physical type of the Entity used to build collector (default all physical type are used).
- iContextModelTag
- the context model tag for which the the collector is requested.
- See also:
- CATSamCharacVersion, CATAnalysisCharacCollector
o FindEntityCollector
-
Finds in the current parent the explicit characteristic pointing to the collector iEntityCollector.
- Parameters:
-
- iEntityCollector
- The instance of CATAnalysisEntityCollector.
- oCharac
- A reference to the explicit characteristic.
NULL_exp if it was not found.
- See also:
- CATAnalysisExplicitCharac
o FindEntityCollector
-
Finds in the current parent the collector characteristic corresponding to a definition.
- Parameters:
-
- iValue
- The CATSamValue.
- iPosition
- The CATSamPosition.
- oCollector
- A pointer to the collector characteristic if it was found.
NULL if it was not found.
- See also:
- CATAnalysisEntityCollector
o GetApplyBy
public HRESULT GetApplyBy( | int& | oNumber, |
| CATSamExplicitPtr*& | oApplyBy) const |
-
Obtains the array of pointers to the apply-by.
- Parameters:
-
- oNumber
- The number of apply-by.
- oApplyBy[oNumber]
- The array of pointers to the apply-by.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
o GetApplyBy
public HRESULT GetApplyBy( | int& | oNumber, |
| CATSamExplicitPtr*& | oApplyBy, |
| CATSamPosition*& | oApplyByPositions, |
| int*& | oApplyByNumbers) const |
-
Obtains the array of pointers to the apply-by, the array of apply types and
the array of apply numbers.
- Parameters:
-
- oNumber
- The number of apply-by.
- oApplyBy[oNumber]
- The array of pointers to the apply-by.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
- oApplyByPositions[oNumber]
- The array of apply positions.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
- oApplyByNumbers[oNumber]
- The array of apply numbers.
This parameter must be equal to NULL when this method is called.
The memory for the array is allocated by this method but must be de-allocated by the caller.
- See also:
- CATSamPosition
o GetApplyByList
-
Obtains the apply-by list.
- Parameters:
-
- oApplyByList
- The apply-by list.
- See also:
- CATAnalysisExplicitList
o GetCategory
-
Obtains the category of the object.
- Parameters:
-
- oCategory
- The category of the object.
- See also:
- CATSamValue
o GetChildOfType
-
Obtains the first child of a given PhysicalType.
- Parameters:
-
- iPhysicalType
- The PhysicalType
- oChildOfType
- The first child of the given PhysicalType.
- See also:
- CATAnalysisExplicitChild
o GetChildrenList
-
Obtains the list of children.
- Parameters:
-
- oChildrenList
- The list of children.
- See also:
- CATAnalysisExplicitList
o GetChildrenList
-
Obtains the recursive list of children using optional filter.
- Parameters:
-
- ioChildrenList
- A list created by user.
- iCompareType
- A filter criteria.
- iCompareValue
- A pointer to the value used by the filter criteria.
- iRecurse
- If TRUE, then the children list is built recursively in all the hierarchy.
- iConcat
- If TRUE, then the children list is concatenated to previous one.
- See also:
- CATAnalysisExplicitListUsr
o GetPointedObject
-
Gets the pointed parent if proxi status.
- Parameters:
-
- oPointedObject
- the pointed object.
o GetUserName
public HRESULT GetUserName( | const char*(&) | oUserName) const |
-
Retrieves the user name.
A user name is a string provided by the user to identify data.
- Parameters:
-
- oUserName
- The string representing the user name.
o GetUserNumber
public HRESULT GetUserNumber( | int& | oUserNumber) const |
-
Retrieves a user number.
A user number is a number provided by the user to identify data.
- Parameters:
-
- oUserNumber
- The user number.
o IsActivated
-
Returns the activity status.
Legal values:
- TRUE The object is activated.
- FALSE The object is not activated.
o IsPointedByProxy
-
Returns the pointed by proxy status.
Legal values:
- TRUE The object is pointed by a proxy.
This means that it relayed by another explicit object in another field model
in the context of assembly of analysis.
- FALSE The object is not pointed by a proxy.
o IsProxy
-
Returns the proxy status.
Legal values:
- TRUE The object is a proxy.
This means that it is a relay to another explicit object in another field model
in the context of assembly of analysis. To access the "final" object use
GetPointedObject. - FALSE The object is not a proxy.
o RemoveChild
-
Removes one child from the current field model object.
- Parameters:
-
- iChild
- The child to be removed.
- See also:
- CATAnalysisExplicitChild
o RemoveChildren
-
Removes several children from the current field model object.
- Parameters:
-
- iChildren
- The list of children to be removed.
- See also:
- CATAnalysisExplicitList
o SetUserName
public HRESULT SetUserName( | const char* | iUserName) const |
-
Assigns a user name.
A user name is a string provided by the user to identify data.
- Parameters:
-
- iUserName
- The string representing the user name.
o SetUserNumber
public HRESULT SetUserNumber( | int | iUserNumber) const |
-
Assigns a user number.
A user number is a number provided by the user to identify data.
- Parameters:
-
- iUserNumber
- The user number.
o operator =
-
Assignment operator.
- See also:
- CATAnalysisExplicitData
o operator =
-
Assignment operator.
This object is included in the file: CATAnalysisExplicitParent.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit