All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDibModelerUseItf Interface CATIDibStandard

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

interface CATIDibStandard

Interface which describes the object Standard.
This object is responsible for the management of the standard used for annotations creations.

Method Index

o GetEngineeringSymbolDetails(CATUnicodeString&,CATUnicodeString&,CATUnicodeChar&): Retrieves the font name and the char-code value for a symbol with given from the standard.
o GetName(wchar_t**): Gets the name of the standard.
o GetParentName(wchar_t**): Gets the fundamental standard from which the standard is derived.
o GetValue(char*,int*,int*): Read a standard value as an int (array).
o GetValue(char*,double*,int*): Read a standard value as a double (array).
o GetValue(char*,int,int&): Read a standard value as an int (single).
o GetValue(char*,int,double&): Read a standard value as a double (single).
o GetValue(char*,CATUnicodeString**,int*): Read a standard value as a CATUnicodeString (array).
o GetValue(char*,int,CATUnicodeString&): Read a standard value as a CATUnicodeString (single).
o GetValueType(char*,CATDibStandardValueType*,int*): Get the type of a standard value.

Methods

o GetEngineeringSymbolDetails

public virtual GetEngineeringSymbolDetails(	const	`iSymbolName`,
		`oFontName`,
		`oSymbolUnicode`)

Retrieves the font name and the char-code value for a symbol with given from the standard.

Parameters:

iSymbolName: [in] The name of the engineering symbol whose font name and char-code value have to be retrieved.
oFontName: [out] Font name for the requested symbol.
oSymbolUnicode: [out] Symbol unicode value in the above font file.

Returns:

S_OK if the given symbol name is found in the standard (version greater or equal to V5R17) and its font name and are successfuly retrieved. S_FALSE if the given symbol name is found in the standard and its font is not installed on the current system but this symbol corresponds to a basic symbol (default symbols delivered in standard by Dassault Systemes). In this case, oFontName and oSymbolUnicode are valuated with default values specified in standard. E_INVALIDARG iSymbolName is an empty string or not defined in the standard E_FAIL Standard is lower than V5R17 or something fails

o GetName

public virtual GetName( oName)

Gets the name of the standard.

Parameters:

wchar_t: **oName Name of the standard

o GetParentName

public virtual GetParentName( oName)

Gets the fundamental standard from which the standard is derived.

Parameters:

wchar_t: **oName Name of the fundamental standard: ANSI, DIN, JIS, ASME, ISO

o GetValue

public virtual GetValue(	const	`iName`,
		`oValue`,
		`oSize`	`=0`)

Read a standard value as an int (array).

Parameters:

const: char *iName Name of the parameter to read. Ex: "Dimension.DIMLUnderline"
int: *oValue The array in which values will be put
int: *oSize The number of element write in oValue.

o GetValue

public virtual GetValue(	const	`iName`,
		`oValue`,
		`oSize`	`=0`)

Read a standard value as a double (array).

Parameters:

const: char *iName Name of the parameter to read. Ex: "Dimension.DIMLFlippedOverrun"
double: *oValue The array in which values will be put
int: *oSize The number of element write in oValue.

o GetValue

public virtual GetValue(	const	`iName`,
		`iIndex`,
		`oValue`)

Read a standard value as an int (single).

Parameters:

const: char *iName Name of the parameter to read. Ex: "Dimension.DIMLUnderline"
int: iIndex The index of the value to read in the tab
int: & oValue a int in which value will be put.

o GetValue

public virtual GetValue(	const	`iName`,
		`iIndex`,
		`oValue`)

Read a standard value as a double (single).

Parameters:

const: char *iName Name of the parameter to read. Ex: "Dimension.DIMLFlippedOverrun"
int: iIndex The index of the value to read in the tab
double: & oValue a double in which value will be put.

o GetValue

public virtual GetValue(	const	`iName`,
		`oValue`,
		`oSize`	`=0`)

Read a standard value as a CATUnicodeString (array).

Parameters:

const: char *iName Name of the parameter to read. Ex: "General.DefaultToleranceFormat"
CATUnicodeString: **oValue The array adrdess in which values will be put
int: *oSize The number of element write in oValue.

o GetValue

public virtual GetValue(	const	`iName`,
		`iIndex`,
		`oValue`)

Read a standard value as a CATUnicodeString (single).

Parameters:

const: char *iName Name of the parameter to read. Ex: "General.DefaultToleranceFormat"
int: iIndex The index of the value to read in the tab
CATUnicodeString: & oValue a CATUnicodeString in which value will be put.

o GetValueType

public virtual GetValueType(	const	`iName`,
		`oType`,
		`oSize`	`=0`)

Get the type of a standard value.

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