All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisBase Class CATAnalysisExplicitChild
Usage: you must use this class as is. You should never derive it.
public class CATAnalysisExplicitChild
Field model child.
This object is used to provide services common to all objects of the field model
which can be children of entities or sets.
Constructor and Destructor Index
- o
CATAnalysisExplicitChild(CATAnalysisExplicitData&)
- Copy constructor.
- o
CATAnalysisExplicitChild(CATAnalysisExplicitChild&)
- Copy constructor.
- o
CATAnalysisExplicitChild()
- Default constructor.
Method Index
- o
AddParent(CATAnalysisExplicitParent&)
- Adds one parent to the current field model object.
- o
AddParents(CATAnalysisExplicitList&)
- Adds several parents to the current field model object.
- o
Delete()
- Deletes from the field model the object pointed to by the current object.
- o
Delete(CATBoolean)
- Deletes from the field model the object pointed to by the current object.
- o
GetExternalPointer(void*(&))
-
- o
GetExternalTag(CATINT32&)
-
- o
GetParentList(CATAnalysisExplicitList&)
- Obtains the list of parents of the field model object.
- o
GetParents(int&,CATSamExplicitPtr*&,CATSamDataType)
- Obtains the array of pointers to the parents.
- o
GetPhysicalType(char*(&))
- Retrieves the physical type.
- o
GetPhysicalType(CATUnicodeString&)
- Retrieves the physical type.
- o
GetPhysicalType(CATSamPhysicalType&)
- Retrieves the physical type.
- o
GetPointer(CATSamExplicitPtr&)
- Obtains a pointer to the field model object the current object points to.
- o
GetSequentialNumber(int&)
- Retrieves a sequential number.
- o
GetSolverName(char*(&))
- Retrieves the solver name.
- o
GetStatus(int&)
- Retrieves the status.
- o
GetTag(int&)
- Retrieves the tag.
- o
LinkWithPointer(CATSamExplicitPtr&,CATAnalysisExplicitModel*)
- Links the current object with a field model object based on its pointer.
- o
LinkWithTag(int,CATAnalysisExplicitModel*)
- Links the current object with a field model object based on its tag (ie unique identifier).
- o
RemoveParent(CATAnalysisExplicitParent&)
- Removes one parent from the current field model object.
- o
RemoveParents(CATAnalysisExplicitList&)
- Removes several parents from the current field model object.
- o
SetExternalPointer(void*)
-
- o
SetExternalTag(CATINT32)
-
- o
SetPhysicalType(CATSamPhysicalType)
- Assigns a new physical type.
- o
SetSequentialNumber(int)
- Assigns a sequential number.
- o
SetSolverName(char*)
- Assigns a solver name.
- o
UnDelete()
- Delete from the field model the object pointed to by the current object.
- o
operator =(CATAnalysisExplicitData&)
- Assignment operator.
- o
operator =(CATAnalysisExplicitChild&)
- Assignment operator.
Constructor and Destructor
o CATAnalysisExplicitChild
| public CATAnalysisExplicitChild( | const | iData) |
-
Copy constructor.
- See also:
- CATAnalysisExplicitData
o CATAnalysisExplicitChild
| public CATAnalysisExplicitChild( | const | iChild) |
-
Copy constructor.
o CATAnalysisExplicitChild
| public CATAnalysisExplicitChild( | ) |
-
Default constructor.
Methods
o AddParent
| public AddParent( | const | iParent) |
-
Adds one parent to the current field model object.
- Parameters:
-
- iParent
- The parent to be added.
Note : The parent of a set can not be an entity.
- See also:
- CATAnalysisExplicitParent
o AddParents
| public AddParents( | | iParents) |
-
Adds several parents to the current field model object.
- Parameters:
-
- iParents
- The list of parents to be added.
Note : The parents of a set can not be entities.
- See also:
- CATAnalysisExplicitList
o Delete
-
Deletes from the field model the object pointed to by the current object.
o Delete
| public virtual Delete( | | really) |
-
Deletes from the field model the object pointed to by the current object.
- Parameters:
-
- really
- if Really = TRUE, the child is really destroyed.
o GetExternalPointer
| public GetExternalPointer( | | oExternalPointer) |
-
- Deprecated:
- V5R17
Retrieves the external pointer (ie the pointer to an object which does not belong to the field model).
Note that an object has either an external pointer or an external tag but not both.
- Parameters:
-
- oExternalPointer
- The pointer.
o GetExternalTag
| public GetExternalTag( | | oExternalTag) |
-
- Deprecated:
- V5R17
Retrieves the external tag (ie the tag of an object which does not belong to the field model).
Note that an object has either an external pointer or an external tag but not both.
- Parameters:
-
- oExternalTag
- The tag.
o GetParentList
| public GetParentList( | | oParentList) |
-
Obtains the list of parents of the field model object.
- Parameters:
-
- oParentList
- The parent list.
- See also:
- CATAnalysisExplicitList
o GetParents
| public GetParents( | | oNumber, |
| | oParents, |
| | iFilter | = CATSamDataTypeLast) |
-
Obtains the array of pointers to the parents.
- Parameters:
-
- oNumber
- The number of parents.
- oParents[oNumber]
- The array of pointers to the parents.
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.
- iFilter
- Indicates which type of parent should be obtained.
If CATSamDataTypeLast is provided, then all parents are obtained.
- See also:
- CATSamDataType
o GetPhysicalType
| public GetPhysicalType( | const | oIdentity) |
-
Retrieves the physical type.
- Parameters:
-
- oIdentity
- The physical type identity.
o GetPhysicalType
| public GetPhysicalType( | | oString) |
-
Retrieves the physical type.
- Parameters:
-
- oString
- The physical type NLS string.
o GetPhysicalType
| public GetPhysicalType( | | oPhysicalType) |
-
Retrieves the physical type.
- Parameters:
-
- oPhysicalType
- The physical type number in database of rules.
o GetPointer
| public GetPointer( | | oNewExplicitPtr) |
-
Obtains a pointer to the field model object the current object points to.
- Parameters:
-
- oExplicitPtr
- The field model object pointer.
o GetSequentialNumber
| public GetSequentialNumber( | | oSequentialNumber) |
-
Retrieves a sequential number.
A sequential number is a number indicating the position of a data in a list.
- Parameters:
-
- oSequentialNumber
- The sequential number.
o GetSolverName
| public GetSolverName( | const | oSolverName) |
-
Retrieves the solver name.
A solver name is a string used by a particular solver to identify data.
- Parameters:
-
- oSolverName
- The string representing the solver name.
o GetStatus
| public GetStatus( | | oStatus) |
-
Retrieves the status.
- Parameters:
-
- oStatus
- The status of the field model object.
- See also:
- CATSamStatus
o GetTag
-
Retrieves the tag.
- Parameters:
-
- oTag
- The tag.
o LinkWithPointer
| public LinkWithPointer( | const | iExplicitPtr, |
| const | iModel) |
-
Links the current object with a field model object based on its pointer.
- iModel can be set to NULL or to the model used for the object creation. Use GetModel to retreive it.
- iModel can be set to another model that reference the model used for object creation. Use GetContextModel to retreive this new explicit model or
GetModel to retreive the model used for the object creation.
- Parameters:
-
- iExplicitPtr
- The pointer to the field model object.
- iModel
- A pointer to the field model.
- See also:
- CATAnalysisExplicitModel
o LinkWithTag
| public virtual LinkWithTag( | | iTag, |
| const | iModel) |
-
Links the current object with a field model object based on its tag (ie unique identifier).
- Parameters:
-
- iTag
- The tag of the field model object.
- iModel
- A pointer to the field model.
- See also:
- CATAnalysisExplicitModel
o RemoveParent
| public RemoveParent( | const | iParent) |
-
Removes one parent from the current field model object.
- Parameters:
-
- iParent
- The parent to be removed.
- See also:
- CATAnalysisExplicitParent
o RemoveParents
| public RemoveParents( | | iParents) |
-
Removes several parents from the current field model object.
- Parameters:
-
- iParents
- The list of parents to be removed.
- See also:
- CATAnalysisExplicitList
o SetExternalPointer
| public SetExternalPointer( | const | iExternalPointer) |
-
- Deprecated:
- V5R17
Stores an external pointer (ie the pointer to an object which does not belong to the field model).
Note that an object has either an external pointer or an external tag but not both.
- Parameters:
-
- iExternalPointer
- The pointer to store.
o SetExternalTag
| public SetExternalTag( | | iExternalTag) |
-
- Deprecated:
- V5R17
Stores an external tag (ie the tag of an object which does not belong to the field model).
Note that an object has either an external pointer or an external tag but not both.
- Parameters:
-
- iExternalTag
- The tag to store.
o SetPhysicalType
| public SetPhysicalType( | | iPhysicalType) |
-
Assigns a new physical type.
- Parameters:
-
- iPhysicalType
- The new physical type.
This new physical type must not change the field model object type
(ie set, entity or characteristic).
o SetSequentialNumber
| public SetSequentialNumber( | | iSequentialNumber) |
-
Assigns a sequential number.
A sequential number is a number indicating the position of a data in a list.
- Parameters:
-
- iSequentialNumber
- The sequential number.
o SetSolverName
| public SetSolverName( | const | iSolverName) |
-
Assigns a solver name.
A solver name is a string used by a particular solver to identify data.
- Parameters:
-
- iSolverName
- The string representing the solver name.
o UnDelete
| public virtual UnDelete( | ) |
-
Delete from the field model the object pointed to by the current object.
o operator =
| public operator =( | const | iData) |
-
Assignment operator.
- See also:
- CATAnalysisExplicitData
o operator =
| public operator =( | const | iChild) |
-
Assignment operator.
This object is included in the file: CATAnalysisExplicitChild.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit