All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATStrUseItf Interface CATIStrUseReference

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

interface CATIStrUseReference

Interface representing a reference specification for a Structure object.
This reference specification is an abstract object, and may not be a unique object in the design model. The reference specification is defined by a specification object (surface or Plate), which is often imported into the part document for this structure object. This interface will set or retrieve the original specification object, and will retrieve the local object, which may be the same as the specification object, or may be an imported (datum) feature.

Method Index

o GetLocalObject(CATIMmiMechanicalFeature_var&): Get the local feature defining the reference geometry.
o GetRole(CATString&): Get the role of this reference element.
o GetSpecification(CATIPrdObject_var&,CATIMmiMechanicalFeature_var&,CATBoolean): Get the specification objects for this support element.
o IsSynchronized(CATStrSyncStatus&): Analyze whether this reference is Synchronized.
o IsValid(CATStrSupportValidationStatus&): Analyze whether this reference is valid.
o SetSpecification(CATIPrdObject_var&,CATIMmiMechanicalFeature_var&): Set the specification objects for this reference element.
o Synchronize(): Synchronize Import.
o ValidateSpecification(CATIPrdObject_var&,CATIMmiMechanicalFeature_var&,CATStrSupportValidationStatus&): Analyze and validate whether a proposed reference object is valid.

Methods

o GetLocalObject

public virtual GetLocalObject( ospLocalFeature)

Get the local feature defining the reference geometry. This local feature is usually an imported datum feature representing the reference element.

Parameters:

ospLocalFeature: The local feature defining the reference geometry. This feature is usually an imported datum feature. But if the original specification feature is in the same 3DShape representation as where it is referenced, then this local object is the original specification feature.

Returns:

Error code of function.

o GetRole

public virtual GetRole( oRole)

Get the role of this reference element. The role is specific to the element from which this interface was retrieved.

Parameters:

oRole: The role of the reference element. This is an internal name (not NLS translated).

o GetSpecification

public virtual GetSpecification(	`ospRefProdOcc`,
	`ospRefFeature`,
	`ibToLoad`	`=FALSE`)

Get the specification objects for this support element.

Parameters:

ospRefProdOcc: The referenced product occurrence defining the reference element. This product occurrence is unique in a context, so it specifies the assembly context of the product.
ospRefFeature: The referenced feature.
ibToLoad: A boolean flag specifying whether to load the referenced product and representation if they are not already in session.

Returns:

Error code of function.

o IsSynchronized

public virtual IsSynchronized( oSyncStatus)

Analyze whether this reference is Synchronized. If the reference includes an external reference and a local copy of the data, they may be out of sync. If the reference is to a local object, then it is always synchronized. If the reference is not synchronized, you may call Synchronize() to make it in sync.

Parameters:

oSyncStatus

The synchronization status.

CATStrSyncStatusUnknown: The status could not be determined.
CATStrSyncNoLinks: The reference has no link, so it cannot be out of sync.
CATStrSynchronized: The reference local copy is in sync with the original.
CATStrNotSynchronized: The reference local copy is not synchronized with the original.

Returns:

The return status.

TRUE: The reference does not need synchronization (in sync or no link).
FALSE: The reference is not synchronized (and could be).

o IsValid

public virtual IsValid( oValidationStatus)

Analyze whether this reference is valid. A reference may be invalid by itself (if it is the wrong element type or is mandatory but not set), or it may be invalid in combination with other specifications of the owning object.

Parameters:

oValidationStatus

The general status of the validation.

CATStrStatusUnknown: The status could not be determined.
CATStrStatusError: An error occurred in determining the status.
CATStrCommonSupportSurface: The referece is valid.
CATStrNotCommonSupportsurface: The reference is invalid.

Returns:

The return status.

TRUE: The reference is valid (or state could not be determined).
FALSE: The reference is not valid.

If not valid, additional information about what is wrong may be pushed in the error stack, which may be retrieved by calling GetLastError().

o SetSpecification

public virtual SetSpecification(	const	`ispRefProdOcc`,
	const	`ispRefFeature`)

Set the specification objects for this reference element. The specification objects are usually in another mechanical product, and are imported into the current product representation.

Parameters:

ispRefProdOcc: The referenced product occurrence defining the reference element. This product occurrence is unique in a context, so it specifies the full assembly context of the product.
ispRefFeature: The referenced feature. This should be NULL if ispRefProdOcc is a Structures specialized Product and the modeler is supposed to choose the features to reference (and import).

Returns:

Error code of function.

o Synchronize

public virtual Synchronize(

)

Synchronize Import.

Returns:: Error code of function.

o ValidateSpecification

public virtual ValidateSpecification(	const	`ispRefProdOcc`,
	const	`ispRefFeature`,
		`oValidationStatus`)

Analyze and validate whether a proposed reference object is valid. A reference may be invalid by itself (if it is the wrong element type or is mandatory but not set), or it may be invalid in combination with other specifications of the owning object.

Parameters:

ispRefProdOcc

The referenced product occurrence. This product occurrence is unique in a context, so it specifies the assembly context of the product.

ispRefSupport

The referenced feature. In some cases, this feature pointer may be NULL if the product itself is the reference object.

oValidationStatus

The general status of the validation.

CATStrStatusUnknown: The status could not be determined.
CATStrStatusError: An error occurred in determining the status.
CATStrCommonSupportSurface: The referece is valid.
CATStrNotCommonSupportsurface: The reference is invalid.

If not valid, additional information about what is wrong may be pushed in the error stack, which may be retrieved by calling GetLastError().

Returns:

Error code of function.

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