Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftGDT

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftGDT

This interface give access to GDT parameters.

Method Index

o AddReferenceValue(int,int,CATIDftTextRange**): Returns the CATIDftTextRange of reference value.
o AddToleranceValue(int,CATIDftTextRange**): Returns the CATIDftTextRange of tolerance value.
o ClearLowerTextContent(): Clear string of Lower text range.
o ClearUpperTextContent(): Clear string of Upper text range.
o GetReferenceNumber(int,int*): Returns the number of references in a row of the GDT.
o GetRowNumber(int*): Returns the number of lines in the GDT.
o GetTextRange(int,int,CATIDftTextRange**): Returns the CATIDftTextRange of tolerance value and reference value.
o GetToleranceType(int,DftGDTSymbol*): Returns the symbol used in the row of the GDT.
o RemoveLine(int): Delete a line in GDT.
o RemoveReference(int,int): Deletes a reference box and all the following references of a GDT row.
o SetToleranceType(int,DftGDTSymbol): Sets the symbol used in the row of the GDT.

Methods

o AddReferenceValue

public virtual AddReferenceValue(	const	`iRowNumber`,
	const	`iReferenceNumber`,
		`oValue`)

Returns the CATIDftTextRange of reference value. If the given row number doesn't exists the function fails If the reference value already exists *oValue points the reference value text object If the iReferenceNumber equals the row's number of reference plus one, a new reference is created If the iReferenceNumber is greater than the row's number of reference plus one the function fails

Parameters:

iRowNumber: The number of the row to analyse
iReferenceNumber: The modifier to analyse in this row.
oValue: The string of the reference value. See also CATIDftTextRange

o AddToleranceValue

public virtual AddToleranceValue(	const	`iRowNumber`,
		`oValue`)

Returns the CATIDftTextRange of tolerance value. If iRownNumber is equal to the current number of line plus one, a new line is created

Parameters:

iRowNumber: The number of the row to analyse
oValue: The string of the tolerance value. See also CATIDftTextRange

o ClearLowerTextContent

public virtual ClearLowerTextContent(

)

Clear string of Lower text range.
Role: Set void string in TextRange of lower text.

Returns:: S_OK if everything ran ok, otherwise... E_FAIL

o ClearUpperTextContent

public virtual ClearUpperTextContent(

)

Clear string of Upper text range.
Role: Set void string in TextRange of upper text.

Returns:: S_OK if everything ran ok, otherwise... E_FAIL

o GetReferenceNumber

public virtual GetReferenceNumber(	const	`iRowNumber`,
		`oRefNumber`)

Returns the number of references in a row of the GDT.

Parameters:

iRowNumber: The number of the row to analyse.
oRefNumber: The number of references in this row.

o GetRowNumber

public virtual GetRowNumber( oRowNumber)

Returns the number of lines in the GDT.

o GetTextRange

public virtual GetTextRange(	const	`iRowNumber`,
	const	`iNumber`,
		`oValue`)

Returns the CATIDftTextRange of tolerance value and reference value.

Parameters:

iRowNumber: The number of the row to analyse If iRowNumber equals 0 to analyse upper text or lower text. If iRowNumber is greater than 0 analyse tolerance value or reference value.
iNumber: The modifier to analyse in this row: If iRowNumber equals 0 and iNumber = 0 represent upper text If iRowNumber equals 0 and iNumber = 1 represent lower text If iRowNumber is greater than 0 and iNumber equals 0 to analyse tolerance value If iRowNumber is greater than 0 and iNumber is greater than 0 to analyse reference value.
oValue: The string which is specified. If there is no textrange which is corresponded above, then NULL is given back. See also CATIDftTextRange

o GetToleranceType

public virtual GetToleranceType(	const	`iRowNumber`,
		`oSymbol`)

Returns the symbol used in the row of the GDT. If the current symbol is DFT_GDT_NOSYMBOL, the function fails.

Parameters:

iRowNumber: The number of the row to analyze. A iRowNumber of 1 returns the first row value in table
oSymbol: The symbol in this row. See also DftGDTSymbol

o RemoveLine

public virtual RemoveLine( iLineIndex)

Delete a line in GDT.
Role: This method remove tolerance symbol, Tolerance value and references in a line.

Parameters:

iLineIndex: [in] Number of line to remove. 1 =< iLineIndex =< Lines number. Lower and upper text expected.

See also:

Returns:

S_OK if everything ran ok E_INLVALIDARG if line number is out of range, S_FALSE if last line staying is delete, otherwise... E_FAIL

o RemoveReference

public virtual RemoveReference(	const	`iRowNumber`,
	const	`iReferenceNumber`)

Deletes a reference box and all the following references of a GDT row.

Parameters:

iRowNumber: The number of the row
iReferenceNumber: The modifier to delete in this row.

o SetToleranceType

public virtual SetToleranceType(	const	`iRowNumber`,
		`iGDTSymbol`)

Sets the symbol used in the row of the GDT.

Parameters:

iRowNumber: The number of the row analyse. A iRowNumber of 1 returns the first row value in table
iGDTSymbol: The symbol to use in this row. See also DftGDTSymbol

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