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
public CATAnalysisExplicitParent( const CATAnalysisExplicitData& iData)
Copy constructor.
See also:
CATAnalysisExplicitData
o CATAnalysisExplicitParent
public CATAnalysisExplicitParent( const CATAnalysisExplicitParent& iParent)
Copy constructor.

Methods


o AddAssemblyChild
public HRESULT AddAssemblyChild( const CATAnalysisExplicitParent& iChild) const
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
public HRESULT AddChild( const CATAnalysisExplicitChild& iChild) const
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
public HRESULT AddChildren(CATAnalysisExplicitList& iChildren) const
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
public HRESULT 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
public HRESULT DeleteCharacCollector( const CATAnalysisCharacCollector*& iCharacCollector)
Delete a CharacCollector under the current field model object.
Parameters:
iCharacCollector
A pointer to the CATAnalysisCharacCollector to be deleted.
See also:
CATAnalysisCharacCollector
o DeleteEntityCollector
public HRESULT DeleteEntityCollector( const CATAnalysisEntityCollector*& iEntityCollector)
Delete an EntityCollector under the current field model object.
Parameters:
iEntityCollector
A pointer to the CATAnalysisEntityCollector to be deleted.
See also:
CATAnalysisEntityCollector
o FindCharacCollector
public HRESULT FindCharacCollector( const CATAnalysisCharacCollector* iCharacCollector,
CATAnalysisExplicitCharac& oCharac) const
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
public HRESULT FindCharacCollector(CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
const CATString& iPosition,
const int iNumOccurrence,
CATAnalysisCharacCollector*& oCollector,
const int iEntityFlagsNumber= 0,
const char* const iEntityFlags= NULL,
CATSamPhysicalType iEntityPhysicalType= CATSamPhysicalTypeNone,
const int iContextModelTag= -1) const
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
public HRESULT FindEntityCollector( const CATAnalysisEntityCollector* iEntityCollector,
CATAnalysisExplicitCharac& oCharac) const
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
public HRESULT FindEntityCollector( const CATSamValue& iValue,
const CATString& iPosition,
CATAnalysisEntityCollector*& oCollector) const
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
public HRESULT GetApplyByList(CATAnalysisExplicitList& oApplyByList) const
Obtains the apply-by list.
Parameters:
oApplyByList
The apply-by list.
See also:
CATAnalysisExplicitList
o GetCategory
public HRESULT GetCategory(CATSamValue& oCategory) const
Obtains the category of the object.
Parameters:
oCategory
The category of the object.
See also:
CATSamValue
o GetChildOfType
public HRESULT GetChildOfType( const CATSamPhysicalType& iPhysicalType,
CATAnalysisExplicitChild& oChildOfType) const
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
public HRESULT GetChildrenList(CATAnalysisExplicitList& oChildrenList) const
Obtains the list of children.
Parameters:
oChildrenList
The list of children.
See also:
CATAnalysisExplicitList
o GetChildrenList
public HRESULT GetChildrenList(CATAnalysisExplicitListUsr& ioChildrenList,
CATSamCompareType iCompareType= CATSamCompareTypeLast,
const void* iCompareValue= NULL,
CATBoolean iRecurse= FALSE,
CATBoolean iConcat= FALSE) const
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
public HRESULT GetPointedObject(CATAnalysisExplicitParent& oPointedObject) const
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
public CATBoolean IsActivated()const
Returns the activity status. Legal values:
o IsPointedByProxy
public CATBoolean IsPointedByProxy()const
Returns the pointed by proxy status. Legal values:
o IsProxy
public CATBoolean IsProxy()const
Returns the proxy status. Legal values:
o RemoveChild
public HRESULT RemoveChild( const CATAnalysisExplicitChild& iChild) const
Removes one child from the current field model object.
Parameters:
iChild
The child to be removed.
See also:
CATAnalysisExplicitChild
o RemoveChildren
public HRESULT RemoveChildren(CATAnalysisExplicitList& iChildren) const
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 =
public CATAnalysisExplicitParent operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
See also:
CATAnalysisExplicitData
o operator =
public CATAnalysisExplicitParent operator =( const CATAnalysisExplicitParent& iParent)
Assignment operator.

This object is included in the file: CATAnalysisExplicitParent.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit

Copyright © 2003, Dassault Systèmes. All rights reserved.