All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFmtModelInterfaces Interface CATIFmtLocalSpecification

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

interface CATIFmtLocalSpecification

Interface representing a local specification within a Mesh Part.
Role: This interface should be used to create local Specifications of a Mesh Part,

Method Index

o AddSupports(CATUnicodeString&,CATFmtListOfPath&): Defines the support of the local specification.
o GetAttribute(CATUnicodeString&,int&): Retreives the integer value of a local specification.
o GetAttribute(CATUnicodeString&,double&): Retreives the real double value of a local specification.
o GetAttribute(CATUnicodeString&,CATUnicodeString&): Retreives the Character Value of a local specification.
o GetBasicComponent(CATUnicodeString&,CATBaseUnknown*&): Retreives the Basic component of a local specification.
o GetExternalReferences(CATUnicodeString&,CATFmtListOfPath&): Retreives the external reference of the local specification.
o GetLitteral(CATUnicodeString&,CATBaseUnknown*&): Retreives the Litteral Value of a local specification attribute.
o GetMeshPart(CATIFmtMeshPart*&): Retreives the associated MeshPart
o GetSupports(CATUnicodeString&,CATFmtListOfPath&): Retreives all supports.
o RemoveExternalReferences(CATUnicodeString&,CATFmtListOfPath&): Removes the external reference of the local specification.
o RemoveSupports(CATUnicodeString&,CATFmtListOfPath&): Removes the support of the local specification.
o SetAttribute(CATUnicodeString&,int): Valuates a local specification attribute to an integer value.
o SetAttribute(CATUnicodeString&,double): Valuates a local specification attribute to a real double value.
o SetAttribute(CATUnicodeString&,CATUnicodeString&): Valuates a local specification attribute to a Character value.
o SetExternalReferences(CATUnicodeString&,CATFmtListOfPath&): Defines the external reference of the local specification.

Methods

o AddSupports

public virtual AddSupports(	const	`iName`,
		`iSupports`)

Defines the support of the local specification.
Role: A support is defined by a list of CATFmtPath

Parameters:

iName: Name of the support of local specification.
iSupports: The list of supports.

Returns:

An HRESULT.
Legal values:

S_OK: The support has been successfully created.
E_FAIL: The support is not allowed for this local specification.

o GetAttribute

public virtual GetAttribute(	const	`iName`,
		`oValue`)

Retreives the integer value of a local specification.

Parameters:

iName: Name of the local specification.
oValue: Integer value.

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o GetAttribute

public virtual GetAttribute(	const	`iName`,
		`oValue`)

Retreives the real double value of a local specification.

Parameters:

iName: Name of the local specification.
iValue: Real double value. ( In case of Length, oValue is evaluated in millimeters ).

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o GetAttribute

public virtual GetAttribute(	const	`iName`,
		`oValue`)

Retreives the Character Value of a local specification.

Parameters:

iName: Name of the local specification.
oValue: Character value.

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o GetBasicComponent

public virtual GetBasicComponent(	const	`iName`,
		`oValue`)

Retreives the Basic component of a local specification.

Parameters:

iName: Name of the attribute of the local specification.
oValue: [out, CATBaseUnknown#Release] CATBaseUnknown value.

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o GetExternalReferences

public virtual GetExternalReferences(	const	`iName`,
		`iSupports`)

Retreives the external reference of the local specification.
Role: An external reference is defined by a list of CATFmtPath

Parameters:

iName: Name of the external reference of local specification.
iSupports: The list of supports.

Returns:

An HRESULT.
Legal values:

S_OK: The external refererence has been successfully retreived.
E_FAIL: The external refererence can not be retreived for this Local Specification.

o GetLitteral

public virtual GetLitteral(	const	`iName`,
		`oValue`)

Retreives the Litteral Value of a local specification attribute.

Parameters:

iName: Name of the attribute of the local specification.
oValue: CATBaseunknown value : the dedicated litteral.

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o GetMeshPart

public virtual GetMeshPart( oMeshPart)

Retreives the associated MeshPart

Parameters:

oMeshPart: [out, CATBaseUnknown#Release] MeshPart associated to this Local Specification.

o GetSupports

public virtual GetSupports(	const	`iName`,
		`iSupports`)

Retreives all supports.
Role: A support is defined by by a list of CATFmtPath

Parameters:

iName: Name of the support of local specification.
iSupports: The list of supports.

Returns:

An HRESULT.
Legal values:

S_OK: The support has been successfully retreived.
E_FAIL: The support can not be retreived for this Local Specification.

o RemoveExternalReferences

public virtual RemoveExternalReferences(	const	`iName`,
		`iSupports`)

Removes the external reference of the local specification.
Role: An external reference is defined by a list of CATFmtPath

Parameters:

iName: Name of the external reference of local specification.
iSupports: The list of supports.

Returns:

An HRESULT.
Legal values:

S_OK: The external refererence has been successfully removed.
E_FAIL: The external refererence can not be removed for this Local Specification.

o RemoveSupports

public virtual RemoveSupports(	const	`iName`,
		`iSupports`)

Removes the support of the local specification. .
Role: A support is defined by by a list of CATFmtPath

Parameters:

iName: Name of the support of local specification.
iSupports: The list of supports.

Returns:

An HRESULT.
Legal values:

S_OK: The support has been successfully removed.
E_FAIL: The support can not be removed for this Local Specification.

o SetAttribute

public virtual SetAttribute(	const	`iName`,
		`iValue`)

Valuates a local specification attribute to an integer value.

Parameters:

iName: Name of the local specification.
iValue: Integer value to be used for the attribute.

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o SetAttribute

public virtual SetAttribute(	const	`iName`,
		`iValue`)

Valuates a local specification attribute to a real double value.

Parameters:

iName: Name of the local specification.
iValue: Real double value to be used for the attribute. ( In case of Length, oValue is evaluated in millimeters ).

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o SetAttribute

public virtual SetAttribute(	const	`iName`,
	const	`iValue`)

Valuates a local specification attribute to a Character value.

Parameters:

iName: Name of the local specification.
iValue: Character value to be used for the attribute.

Returns:

An HRESULT.
Legal values:

S_OK: The attribute has been successfully set.
E_FAIL: The attribute does not exist for this specification.

o SetExternalReferences

public virtual SetExternalReferences(	const	`iName`,
		`iSupports`)

Defines the external reference of the local specification.
Role: An external reference is defined by a list of CATFmtPath

Parameters:

iName: Name of the external reference of local specification.
iSupports: The list of supports.

Returns:

An HRESULT.
Legal values:

S_OK: The external refererence has been successfully set.
E_FAIL: The external refererence is not allowed for this Local Specification.

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