All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisBase Class CATAnalysisExplicitRulesData
Usage: you must use this class as is. You should never derive it.
public class CATAnalysisExplicitRulesData
This object is used to encapsulate the database of rules.
Constructor and Destructor Index
- o
CATAnalysisExplicitRulesData(CATUnicodeString&,int)
-
- o
~CATAnalysisExplicitRulesData()
- Destructor.
Method Index
- o
CheckValidity(CATAnalysisExplicitChild&,CATAnalysisExplicitListUsr&,int)
- Checks the validity of the current field model object relatively to the database of rules.
- o
GetNumberOfPhysicalTypes()
- Returns the number of physical types available with the current database of rules.
- o
GetPhysicalTypeApplyByInfo(CATSamPhysicalType,int&,CATSamPhysicalType*(&))
-
- o
GetPhysicalTypeApplyToInfo(CATSamPhysicalType,int&,CATSamPhysicalType*(&),CATSamPosition*(&))
-
- o
GetPhysicalTypeAuthorizedApplyBy(CATSamPhysicalType,int&,CATSamPhysicalType*&)
- Retrieves the list of authorized applied of a physical type.
- o
GetPhysicalTypeAuthorizedApplyTo(CATSamPhysicalType,int&,CATSamPhysicalType*&,CATSamPosition*&)
- Retrieves the list of authorized apply of a physical type.
- o
GetPhysicalTypeAuthorizedChildren(CATSamPhysicalType,int&,CATSamPhysicalType*&)
- Retrieves the list of authorized children of a physical type.
- o
GetPhysicalTypeAuthorizedParents(CATSamPhysicalType,int&,CATSamPhysicalType*&)
- Retrieves the list of authorized parents of a physical type.
- o
GetPhysicalTypeAuthorizedValues(CATSamPhysicalType,int&,CATSamPhysicalType*&)
- Retrieves the list of authorized physical types that can be pointed.
- o
GetPhysicalTypeCategory(CATSamPhysicalType,CATSamValue&)
- Retrieves the category of a physical type.
- o
GetPhysicalTypeChildrenInfo(CATSamPhysicalType,int&,CATSamPhysicalType*(&))
-
- o
GetPhysicalTypeConnectivity(CATSamPhysicalType,char*(&))
- Retrieves the connectivity information of a physical type.
- o
GetPhysicalTypeDataType(CATSamPhysicalType,CATSamDataType&)
- Retrieves the data type of a physical type.
- o
GetPhysicalTypeDofs(CATSamPhysicalType,int&,int)
- Retrieves the degrees of freedom information of a physical type.
- o
GetPhysicalTypeIdentity(CATSamPhysicalType,char*(&))
- Retrieves the identifier of a physical type.
- o
GetPhysicalTypeMathematicalInfo(CATSamPhysicalType,CATSamMathType&,CATSamValue&,int&,int&)
- Retrieves the mathematical information of a physical type.
- o
GetPhysicalTypeName(CATSamPhysicalType,char*(&))
- Converts a physical type number into a NLS name.
- o
GetPhysicalTypeName(CATSamPhysicalType,CATUnicodeString&)
- Converts a physical type number into a NLS name.
- o
GetPhysicalTypeNumber(char*,CATSamPhysicalType&)
- Retrieves a physical type, that is, a number ID corresponding to its identifier.
- o
GetPhysicalTypeParentInfo(CATSamPhysicalType,int&,CATSamPhysicalType*(&))
-
- o
GetPhysicalTypeReferencesValues(CATSamPhysicalType,CATSamPhysicalType,int&,CATSamPhysicalType*&)
- Retrieves the references for a physical type in a well defined context.
- o
GetPhysicalTypeReferences(CATSamPhysicalType,CATSamPhysicalType,int&,CATSamPhysicalType*(&))
-
- o
GetPhysicalTypeSubTypes(CATSamPhysicalType,int&,CATSamSubType*(&))
-
- o
GetPhysicalTypeUnit(CATSamPhysicalType,char*(&))
- Retrieves the unit of a physical type.
- o
GetPhysicalTypeValuesList(CATSamPhysicalType,int&,CATSamPhysicalType*(&))
-
- o
IsPhysicalTypeCardinalityRangeable(CATSamPhysicalType,CATSamPhysicalType)
-
- o
IsPhysicalTypeCollectable(CATSamPhysicalType,CATSamPhysicalType)
- Returns if a physical type is collectable.
- o
IsPhysicalTypeMandatory(CATSamPhysicalType,CATSamPhysicalType)
- Returns if a physical type is mandatory.
- o
IsPhysicalTypeReachable(CATSamPhysicalType,CATSamPhysicalType)
- Returns if a physical type is reachable from another one.
Constructor and Destructor
o CATAnalysisExplicitRulesData
| public CATAnalysisExplicitRulesData( | const | iFileName, |
| | iVersion | = 51700) |
-
- Deprecated:
- V5R17
No one is expected to create new Rules Data.
Constructor.
- Parameters:
-
- iFileName
- The file name of the database of rules.
If no path is specified, this file is searched in directories set by the CATReffilesPath environment variable.
o ~CATAnalysisExplicitRulesData
| public virtual ~CATAnalysisExplicitRulesData( | ) |
-
Destructor.
Methods
o CheckValidity
| public CheckValidity( | const | iChild, |
| | oList, |
| const | Check | = CATSamCheckTypeAll) |
-
Checks the validity of the current field model object relatively to the database of rules.
- Parameters:
-
- iChild
- The child that you want to check.
- oList
- A user list containing the offending object followed by the objects recursively traversed and ending by the current object.
This parameter must be equal to NULL_exp when this method is called.
- Check
- It specifies the CATSamCheckType mode.
- See also:
- CATAnalysisExplicitChild, CATAnalysisExplicitListUsr, CATSamCheckType
o GetNumberOfPhysicalTypes
| public GetNumberOfPhysicalTypes( | ) |
-
Returns the number of physical types available with the current database of rules.
o GetPhysicalTypeApplyByInfo
| public GetPhysicalTypeApplyByInfo( | | iPhysicalType, |
| | oNumberOfApplyBy, |
| const | oApplyByTypesPtr) |
-
- Deprecated:
- V5R17
Use
GetPhysicalTypeAuthorizedApplyBy instead. Retrieves the list of authorized applied of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfApplyBy
- The size of the list of authorized applied.
- oApplyByTypesPtr
- A pointer to the list of authorized applied.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeApplyToInfo
| public GetPhysicalTypeApplyToInfo( | | iPhysicalType, |
| | oNumberOfApplyTo, |
| const | oApplyToTypesPtr, |
| const | oApplyToPositionsPtr) |
-
- Deprecated:
- V5R17
Use
GetPhysicalTypeAuthorizedApplyTo instead. Retrieves the list of authorized apply of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfApplyTo
- The size of the list of authorized applies.
- oApplyToTypesPtr
- A pointer to the list of authorized applies.
- oApplyByPositionsPtr
- A pointer to the list of authorized positions of applies.
- See also:
- CATSamPhysicalType, CATSamPosition, CATSamDataType
o GetPhysicalTypeAuthorizedApplyBy
| public GetPhysicalTypeAuthorizedApplyBy( | | iPhysicalType, |
| | oNumberOfApplyBy, |
| | oAuthorizedApplyBy) |
-
Retrieves the list of authorized applied of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfApplyBy
- The size of the list of authorized applied.
- oAuthorizedApplyBy
- A pointer to the list of authorized applied.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeAuthorizedApplyTo
| public GetPhysicalTypeAuthorizedApplyTo( | | iPhysicalType, |
| | oNumberOfApplyTo, |
| | oAuthorizedApplyTo, |
| | oAuthorizedApplyToPositions) |
-
Retrieves the list of authorized apply of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfApplyTo
- The size of the list of authorized applies.
- oAuthorizedApplyTo
- A pointer to the list of authorized applies.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- oAuthorizedApplyToPositions
- A pointer to the list of authorized positions of applies.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- See also:
- CATSamPhysicalType, CATSamPosition, CATSamDataType
o GetPhysicalTypeAuthorizedChildren
| public GetPhysicalTypeAuthorizedChildren( | | iPhysicalType, |
| | oNumberOfChildren, |
| | oAuthorizedChildren) |
-
Retrieves the list of authorized children of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfChildren
- The size of the list of authorized children.
- oAuthorizedChildren
- A pointer to the list of Authorized Children.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeAuthorizedParents
| public GetPhysicalTypeAuthorizedParents( | | iPhysicalType, |
| | oNumberOfParents, |
| | oAuthorizedParents) |
-
Retrieves the list of authorized parents of a physical type.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfParents
- The size of the list of authorized parents.
- oAuthorizedParents
- A pointer to the list of Authorized parents.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- See also:
- CATSamPhysicalType
o GetPhysicalTypeAuthorizedValues
| public GetPhysicalTypeAuthorizedValues( | | iPhysicalType, |
| | oNumberOfValues, |
| | oAuthorizedValues) |
-
Retrieves the list of authorized physical types that can be pointed.
This specific and restrictive information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfValues
- The size of the restrictive list of values.
- oAuthorizedValues
- A pointer to the list of authorized values.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeCategory
| public GetPhysicalTypeCategory( | | iPhysicalType, |
| | oCategory) |
-
Retrieves the category of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oCategory
- The CATSamValue category of the objects with this physical type.
- See also:
- CATSamPhysicalType, CATSamValue, CATSamDataType
o GetPhysicalTypeChildrenInfo
| public GetPhysicalTypeChildrenInfo( | | iPhysicalType, |
| | oNumberOfChildren, |
| const | oChildrenTypesPtr) |
-
- Deprecated:
- V5R17
Use
GetPhysicalTypeAuthorizedChildren instead. Retrieves the list of authorized children of a physical type.
This specific information is only for physical types which are defined either as a CATSamDataTypeEntity or as a CATSamDataTypeSet.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfChildren
- The size of the list of authorized children.
- oChildrenTypesPtr
- A pointer to the list.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeConnectivity
| public GetPhysicalTypeConnectivity( | | iPhysicalType, |
| const | oConnectivity) |
-
Retrieves the connectivity information of a physical type.
This specific information is only for physical types which are defined as a CATSamDataTypeEntity with category CATSamValueElement or CATSamValueVirtualElement.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oConnectivity
- The connectivity of the objects with this physical type.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeDataType
| public GetPhysicalTypeDataType( | | iPhysicalType, |
| | oDataType) |
-
Retrieves the data type of a physical type.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oDataType
- The data type of the objects with this physical type.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeDofs
| public GetPhysicalTypeDofs( | | iPhysicalType, |
| | oDofs, |
| | iIndice | = 0) |
-
Retrieves the degrees of freedom information of a physical type.
This specific information is only for physical types which are defined as a CATSamDataTypeEntity with category CATSamValueElement or CATSamValueVirtualElement.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oDofs
- The degrees of freedom which are a combination of CATSamDof flags.
- iIndice
- The indice corresponding to a zone of element where the degrees of freedom is requested.
- See also:
- CATSamPhysicalType, CATSamDof, CATSamDataType
o GetPhysicalTypeIdentity
| public GetPhysicalTypeIdentity( | | iPhysicalType, |
| const | oIdentity) |
-
Retrieves the identifier of a physical type.
- Parameters:
-
- iPhysicalType
- The physical type to convert.
- oIdentity
- The identifier.
This identifier is intended to be used during programming.
- See also:
- CATSamPhysicalType
o GetPhysicalTypeMathematicalInfo
| public GetPhysicalTypeMathematicalInfo( | | iPhysicalType, |
| | oMathematicalType, |
| | oValue, |
| | oDimension, |
| | oNumberOfOccurrences) |
-
Retrieves the mathematical information of a physical type.
This specific information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oMathematicalType
- The mathematical type.
- oValue
- The type of value.
- oDimension
- The mathematical dimension (between 1 and 6).
- oNumberOfOccurrences
- The requested number of occurrences that the characteristic data is composed of.
If 0, then any number of occurrences is authorized.
- See also:
- CATSamPhysicalType, CATSamMathType, CATSamValue, CATSamDataType
o GetPhysicalTypeName
| public GetPhysicalTypeName( | | iPhysicalType, |
| const | oName) |
-
Converts a physical type number into a NLS name.
- Parameters:
-
- iPhysicalType
- The physical type to convert.
- oName
- The name corresponding to the physical type.
if no NLS name has been found, then a pointer to the string "???" is returned.
- See also:
- CATSamPhysicalType
o GetPhysicalTypeName
| public GetPhysicalTypeName( | | iPhysicalType, |
| | oName) |
-
Converts a physical type number into a NLS name.
- Parameters:
-
- iPhysicalType
- The physical type to convert.
- oName
- The name corresponding to the physical type.
This name is intended to be presented to the user.
- See also:
- CATSamPhysicalType
o GetPhysicalTypeNumber
| public GetPhysicalTypeNumber( | const | iIdentity, |
| | oPhysicalType) |
-
Retrieves a physical type, that is, a number ID corresponding to its identifier.
- Parameters:
-
- iIdentity
- The identifier.
- oPhysicalType
- The corresponding physical type.
- See also:
- CATSamPhysicalType
o GetPhysicalTypeParentInfo
| public GetPhysicalTypeParentInfo( | | iPhysicalType, |
| | oNumberOfParents, |
| const | oParentsPhysicalTypes) |
-
- Deprecated:
- V5R17
Use
GetPhysicalTypeAuthorizedParents instead. Retrieves the list of authorized parents of a physical type.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfParents
- The size of the list of authorized parents.
- oParentsPhysicalTypes
- A pointer to the list.
- See also:
- CATSamPhysicalType
o GetPhysicalTypeReferencesValues
| public GetPhysicalTypeReferencesValues( | | iPhysicalType, |
| | iParentType, |
| | oNumberOfReferencedTypes, |
| | oReferencesValues) |
-
Retrieves the references for a physical type in a well defined context.
This specific information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- iParentType
- The physical type specifying the context.
- oReferencesValues
- A pointer to the list of references values.
Lifecycle rules
Must be set to NULL before calling the method, and deleted after use.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeReferences
| public GetPhysicalTypeReferences( | | iPhysicalType, |
| | iParentType, |
| | oNumberOfReferencedTypes, |
| | oReferencedTypesPtr) |
-
- Deprecated:
- V5R17
Use
GetPhysicalTypeReferencesValues instead. Retrieves the references for a physical type in a well defined context.
This specific information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- iParentType
- The physical type specifying the context.
- oReferencedType
- The referenced type.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeSubTypes
| public GetPhysicalTypeSubTypes( | | iPhysicalType, |
| | oNumberOfSubTypes, |
| | oSubTypesPtr) |
-
- Deprecated:
- V5R17
Retrieves the list of authorized subtypes associated to a physical type.
This specific and restrictive information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfSubTypes
- The size of the list of authorized subtypes.
- oSubTypesPtr
- A pointer to the list.
- See also:
- CATSamPhysicalType, CATSamSubType, CATSamDataType
o GetPhysicalTypeUnit
| public GetPhysicalTypeUnit( | | iPhysicalType, |
| const | oUnit) |
-
Retrieves the unit of a physical type.
This specific information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oUnit
- The string corresponding to the unit.
- See also:
- CATSamPhysicalType, CATSamDataType
o GetPhysicalTypeValuesList
| public GetPhysicalTypeValuesList( | | iPhysicalType, |
| | oNumberOfValues, |
| const | oValuesList) |
-
- Deprecated:
- V5R17
Use
GetPhysicalTypeAuthorizedValues instead. Retrieves the list of authorized physical types that can be pointed.
This specific and restrictive information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- oNumberOfValues
- The size of the restrictive list of values.
- oValuesList
- A pointer to the list.
- See also:
- CATSamPhysicalType, CATSamDataType
o IsPhysicalTypeCardinalityRangeable
| public IsPhysicalTypeCardinalityRangeable( | | iPhysicalType, |
| | iParentType) |
-
- Deprecated:
- V5R17
Returns if the cardinality (i.e. the number of authorized instances) is rangeable at runtime.
If not, it means that the cardinality is definitely fixed in rules database.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- iParentType
- The physical type specifying the context.
- See also:
- CATSamPhysicalType
o IsPhysicalTypeCollectable
| public IsPhysicalTypeCollectable( | | iPhysicalType, |
| | iParentType) |
-
Returns if a physical type is collectable.
This specific information is only for physical types which are defined as a CATSamDataTypeCharac.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- iParentType
- The physical type specifying the context.
- See also:
- CATSamPhysicalType, CATSamDataType
o IsPhysicalTypeMandatory
| public IsPhysicalTypeMandatory( | | iPhysicalType, |
| | iParentType) |
-
Returns if a physical type is mandatory.
- Parameters:
-
- iPhysicalType
- The physical type for which the information is requested.
- iParentType
- The physical type specifying the context.
- See also:
- CATSamPhysicalType
o IsPhysicalTypeReachable
| public IsPhysicalTypeReachable( | | iPhysicalType, |
| | iContext) |
-
Returns if a physical type is reachable from another one.
- Parameters:
-
- iPhysicalType
- The physical type to reach
- iContext
- The physical type from which request starts
- See also:
- CATSamPhysicalType
This object is included in the file: CATAnalysisExplicitRulesData.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit