All Frameworks Class Hierarchy This Framework Previous Next Indexes
PartInterfaces Interface CATIPrtThreadStandardServices
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPrtThreadStandardServices
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPrtThreadStandardServices
Services to access to standard tables of thread/tap
Role: It enables to instantiate a standard table in a given part and
then to access to all the values in it, in order to valuate the
specifications of a Thread/Tap feature.
Method Index
- o
CreateStandardTable(CATUnicodeString&,CATUnicodeString&,CATISpecObject*)
- Create a table of thread standard from a file in a Part.
- o
RemoveStandardTable(CATUnicodeString&,CATISpecObject*)
- Remove a table of thread standard from a Part.
- o
RetrieveDescriptionsFromStandardTable(CATUnicodeString&,CATISpecObject*,CATListOfCATUnicodeString&)
- Retrieve the list of descriptions in a given table of thread standard
Role: This method reads inside a table in a Part to find the descriptions values of a
standard.
- o
RetrieveValuesFromStandardTable(CATUnicodeString&,CATISpecObject*,CATUnicodeString&,double&,double&,double&)
- Retrieve the values in a given table of thread standard
Role: This method reads inside a table in a Part to find the values corresponding to
a given description or Thread diameter in the table.
Methods
o CreateStandardTable
-
Create a table of thread standard from a file in a Part.
Role: This method instanciates a table in a Part that can be used to
define thread/tap specifications.
- Parameters:
-
- iustrPath
- [in] The path to the file containing all the values that define the standard.
- iustrName
- [in] The name of the standard table to create.
- ipFeature
- [in] A pointer on a feature in the Part. It defines in which Part, the table will
be created.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The table of standard has been successfuly created
- S_FALSE
- The table of standard already exists
- E_INVALIDARG
- iustrPath is not a valid path to a valid file,
or iustrName is empty,
or ipFeature is invalid
- E_FAIL
- Failure during the creation of the table of standard
o RemoveStandardTable
-
Remove a table of thread standard from a Part.
Role: This method removes a table of thread standards from a Part.
- Parameters:
-
- iustrName
- [in] The name of the standard table to remove.
- ipFeature
- [in] A pointer on a feature in the Part. It defines in which Part, the table will
be created.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The table of standard has been successfuly removed
- S_FALSE
- The table of standard has already been removed, doesn't exist or
there is at least one thread feature in the Part that use this table.
- E_INVALIDARG
- iustrName is empty,
or ipFeature is invalid
- E_FAIL
- Failure during the removal of the table of standard.
o RetrieveDescriptionsFromStandardTable
-
Retrieve the list of descriptions in a given table of thread standard
Role: This method reads inside a table in a Part to find the descriptions values of a
standard.
- Parameters:
-
- iustrName
- [in] The name of the standard table.
- ipFeature
- [int] A pointer on a feature in the Part. It defines in which Part, the table has to be found.
- oListString
- [out] A list of standard desriptions corresponding.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The values have been successfuly retrieved from the table
- E_INVALIDARG
- iustrName doesn't exist in the Part,
or ipFeature is invalid
- E_FAIL
- Impossible to retrieve values corresponding to such inputs in the table
o RetrieveValuesFromStandardTable
-
Retrieve the values in a given table of thread standard
Role: This method reads inside a table in a Part to find the values corresponding to
a given description or Thread diameter in the table.
- Parameters:
-
- iustrName
- [in] The name of the standard table.
- ipFeature
- [int] A pointer on a feature in the Part. It defines in which Part, the table has to be found.
- iDescription
- [inout] An Unicodestring used to find the values in the table.
For example : M20x2
- oDiameter
- [out] The value of the hole diameter recommanded for the input description.
- ioThreadDiameter
- [inout] The value of the diameter of the thread
- oThreadPitch
- [out] The value of the pitch of the thread
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The values have been successfuly retrieved from the table
- E_INVALIDARG
- iustrName doesn't exist in the Part,
or ipFeature is invalid
- E_FAIL
- Impossible to retrieve values corresponding to such inputs in the table
This object is included in the file: CATIPrtThreadStandardServices.h
If needed, your Imakefile.mk should include the module: CATPartInterfaces