Inheritance diagram for NXOpen::Assemblies::ClearanceSet:

Classes
struct	Summary
	Summary of the most recent Clearance Analysis results. More...

Public Types
enum	CopyMode { CopyModeNoResults, CopyModeResults, CopyModeInterfBodies }
	Specify the dataset copy mode. More...

enum	InterferenceType { InterferenceTypeSoft, InterferenceTypeTouch, InterferenceTypeHard, InterferenceTypeCont1In2, InterferenceTypeCont2In1, InterferenceTypeNoInterference }
	Specify the type of interference. More...

enum	JobStatus { JobStatusNotAborted, JobStatusAbortedByUser, JobStatusAbortedOnError }
	Specify the job aborted status. More...

enum	PenetrationDepthResult { PenetrationDepthResultNotAttempted, PenetrationDepthResultSuccess, PenetrationDepthResultNoClash, PenetrationDepthResultTouching, PenetrationDepthResultBothSheets, PenetrationDepthResultUnspecifiedError }
	The result of penetration depth calculation. More...

enum	ReanalyzeOutOfDateExcludedPairs { ReanalyzeOutOfDateExcludedPairsCustomerDefault, ReanalyzeOutOfDateExcludedPairsTrue, ReanalyzeOutOfDateExcludedPairsFalse }
	Specify whether to reanalyze out-of-date excluded pairs. More...

enum	ReanalyzePairCalculationMethod { ReanalyzePairCalculationMethodUseStoredMethod, ReanalyzePairCalculationMethodLightweight, ReanalyzePairCalculationMethodExactIfLoaded, ReanalyzePairCalculationMethodExact }
	The analysis method to use when reanalyzing a pair. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
void	CalculatePenetrationDepth (const std::vector< NXOpen::DisplayableObject * > &firstObjects, const std::vector< NXOpen::DisplayableObject * > &secondObjects)
	Calculate penetration depth for a set of hard interferences.

NXOpen::Assemblies::ClearanceSet *	Copy (const NXString &name, NXOpen::Assemblies::ClearanceSet::CopyMode mode)
	Makes a copy of a dataset.

NXOpen::Assemblies::ClearanceSet *	Copy (const char *name, NXOpen::Assemblies::ClearanceSet::CopyMode mode)
	Makes a copy of a dataset.

void	CreateInterferenceGeometry (const std::vector< NXOpen::DisplayableObject * > &firstObjects, const std::vector< NXOpen::DisplayableObject * > &secondObjects)
	Construct interference geometry for a set of hard interferences.

void	Delete ()
	Delete this clearance set Created in NX9.0.0.

void	DeleteInterference (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2)
	Deletes the interference for a given object pair.

void	GetInterferenceData (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, NXOpen::Assemblies::ClearanceSet::InterferenceType type, bool newInterference, std::vector< NXOpen::DisplayableObject * > &interfBodies, NXOpen::Point3d point1, NXOpen::Point3d point2, NXString text, int interfNum, int config, int depthResult, double depth, NXOpen::Vector3d direction, NXOpen::Point3d minPoint, NXOpen::Point3d maxPoint)
	Inquires the data associated with a given pair of interfering objects.

bool	GetIsPairChanged (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2)
	Inquires if an object pair has changed since the last analysis run.

void	GetNextInterference (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, NXOpen::DisplayableObject nextObject1, NXOpen::DisplayableObject nextObject2)
	Cycles the interference in a clearance analysis data set.

int	GetNumberOfInterferences ()
	Inquires the number of interferences stored in a clearance analysis data set.

NXOpen::Assemblies::ClearanceSet::Summary	GetResults ()
	Inquires a summary of the results of the most recent clearance analysis run.

int	GetVersion ()
	Gets the version of a clearance analysis dataset.

void	PerformAnalysis (NXOpen::Assemblies::ClearanceSet::ReanalyzeOutOfDateExcludedPairs reanalyzeOption)
	Perform an analysis on this clearance set with option to specify whether out-of-date excluded pairs will be reanalyzed.

void	ReanalyzePairs (const std::vector< NXOpen::DisplayableObject * > &firstObjects, const std::vector< NXOpen::DisplayableObject * > &secondObjects, NXOpen::Assemblies::ClearanceSet::ReanalyzePairCalculationMethod calculationMethod)
	Reanalyze a set of interferences using the specified analysis method.

void	SetInterferenceText (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, const NXString &text)
	Associates a text string to an interfering object pair.

void	SetInterferenceText (NXOpen::DisplayableObject object1, NXOpen::DisplayableObject object2, const char *text)
	Associates a text string to an interfering object pair.

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

Detailed Description

Represents ClearanceSet .

Currently we don't support KF at this time.

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Assemblies::ClearanceSet::CopyMode

Specify the dataset copy mode.

Enumerator:

CopyModeNoResults	no results
CopyModeResults	results
CopyModeInterfBodies	interf bodies

enum NXOpen::Assemblies::ClearanceSet::InterferenceType

Specify the type of interference.

Enumerator:

InterferenceTypeSoft	soft
InterferenceTypeTouch	touch
InterferenceTypeHard	hard
InterferenceTypeCont1In2	cont1in2
InterferenceTypeCont2In1	cont2in1
InterferenceTypeNoInterference	no interference

enum NXOpen::Assemblies::ClearanceSet::JobStatus

Specify the job aborted status.

Enumerator:

JobStatusNotAborted	not aborted
JobStatusAbortedByUser	aborted by user
JobStatusAbortedOnError	aborted on error

enum NXOpen::Assemblies::ClearanceSet::PenetrationDepthResult

The result of penetration depth calculation.

Enumerator:

PenetrationDepthResultNotAttempted	not attempted
PenetrationDepthResultSuccess	success
PenetrationDepthResultNoClash	no clash
PenetrationDepthResultTouching	touching
PenetrationDepthResultBothSheets	both sheets
PenetrationDepthResultUnspecifiedError	unspecified error

enum NXOpen::Assemblies::ClearanceSet::ReanalyzeOutOfDateExcludedPairs

Specify whether to reanalyze out-of-date excluded pairs.

Enumerator:

ReanalyzeOutOfDateExcludedPairsCustomerDefault	customer default
ReanalyzeOutOfDateExcludedPairsTrue	true
ReanalyzeOutOfDateExcludedPairsFalse	false

enum NXOpen::Assemblies::ClearanceSet::ReanalyzePairCalculationMethod

The analysis method to use when reanalyzing a pair.

Enumerator:

ReanalyzePairCalculationMethodUseStoredMethod	Use the clearance set's defined analysis method.
ReanalyzePairCalculationMethodLightweight	lightweight
ReanalyzePairCalculationMethodExactIfLoaded	exact if loaded
ReanalyzePairCalculationMethodExact	exact

Member Function Documentation

void NXOpen::Assemblies::ClearanceSet::CalculatePenetrationDepth	(	const std::vector< NXOpen::DisplayableObject * > &	firstObjects,
		const std::vector< NXOpen::DisplayableObject * > &	secondObjects
	)

Calculate penetration depth for a set of hard interferences.

The interferences must be specified using two parallel arrays: the objects in the first interference should be given in the first elements of the arrays, the objects in the second interference should be given in the second elements of the arrays, etc.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

firstObjects	The first object of each interference. Must be the same size as secondObjects.
secondObjects	The second object of each interference. Must be the same size as firstObjects.

NXOpen::Assemblies::ClearanceSet* NXOpen::Assemblies::ClearanceSet::Copy	(	const NXString &	name,
		NXOpen::Assemblies::ClearanceSet::CopyMode	mode
	)

Makes a copy of a dataset.

You must supply a unique name. There are three modes in which to copy the dataset: Assemblies::ClearanceSet::CopyMode::NoResults only copies the setup data. The version of the new dataset is set to zero (meaning clearance analysis has not been run); Assemblies::ClearanceSet::CopyMode::Results makes a copy of the current analysis results, but not the interference bodies; Assemblies::ClearanceSet::CopyMode::InterfBodies makes a complete copy of the results. The name must be less than MAX_LINE_SIZE characters long

Returns: the dataset that is copied
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

name	the name of the new dataset NOTE: The full Unicode character set is not supported for this parameter.
mode	copy mode

NXOpen::Assemblies::ClearanceSet* NXOpen::Assemblies::ClearanceSet::Copy	(	const char *	name,
		NXOpen::Assemblies::ClearanceSet::CopyMode	mode
	)

Makes a copy of a dataset.

You must supply a unique name. There are three modes in which to copy the dataset: Assemblies::ClearanceSet::CopyMode::NoResults only copies the setup data. The version of the new dataset is set to zero (meaning clearance analysis has not been run); Assemblies::ClearanceSet::CopyMode::Results makes a copy of the current analysis results, but not the interference bodies; Assemblies::ClearanceSet::CopyMode::InterfBodies makes a complete copy of the results. The name must be less than MAX_LINE_SIZE characters long

Returns: the dataset that is copied
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

name	the name of the new dataset NOTE: The full Unicode character set is not supported for this parameter.
mode	copy mode

void NXOpen::Assemblies::ClearanceSet::CreateInterferenceGeometry	(	const std::vector< NXOpen::DisplayableObject * > &	firstObjects,
		const std::vector< NXOpen::DisplayableObject * > &	secondObjects
	)

Construct interference geometry for a set of hard interferences.

The interferences must be specified using two parallel arrays: the objects in the first interference should be given in the first elements of the arrays, the objects in the second interference should be given in the second elements of the arrays, etc.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

firstObjects	The first object of each interference. Must be the same size as secondObjects.
secondObjects	The second object of each interference. Must be the same size as firstObjects.

void NXOpen::Assemblies::ClearanceSet::Delete ( )

Delete this clearance set
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::ClearanceSet::DeleteInterference	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2
	)

Deletes the interference for a given object pair.

Both objects must be members of the given data set. If the object pair does not refer to an existing interference, an error is returned. All data associated with the interference is deleted.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object in the pair
object2	the second object in the pair

void NXOpen::Assemblies::ClearanceSet::GetInterferenceData	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		NXOpen::Assemblies::ClearanceSet::InterferenceType *	type,
		bool *	newInterference,
		std::vector< NXOpen::DisplayableObject * > &	interfBodies,
		NXOpen::Point3d *	point1,
		NXOpen::Point3d *	point2,
		NXString *	text,
		int *	interfNum,
		int *	config,
		int *	depthResult,
		double *	depth,
		NXOpen::Vector3d *	direction,
		NXOpen::Point3d *	minPoint,
		NXOpen::Point3d *	maxPoint
	)

Inquires the data associated with a given pair of interfering objects.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object in the pair
object2	the second object in the pair
type	the interference type
newInterference	the flag for new interference
interfBodies	the list of interference bodies
point1	a point on the first object
point2	a point on the second object
text	text associated with the interference
interfNum	a unique number for the interference
config	the configuration index
depthResult	result status of penetration depth calculation
depth	depth of penetration
direction	a unit vector indicating the direction of penetration
minPoint	the points on the interference region at the extremes of depth
maxPoint	the points on the interference region at the extremes of depth

bool NXOpen::Assemblies::ClearanceSet::GetIsPairChanged	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2
	)

Inquires if an object pair has changed since the last analysis run.

Both objects must be solid bodies or facet models that are members of the clearance analysis data set. If either object has changed since the last analysis run, then isChanged is returned as TRUE. If no analysis has been run on either of the objects, TRUE is returned.

Returns: Has this pair changed since the last analysis run?
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object in the pair
object2	the second object in the pair

void NXOpen::Assemblies::ClearanceSet::GetNextInterference	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		NXOpen::DisplayableObject **	nextObject1,
		NXOpen::DisplayableObject **	nextObject2
	)

Cycles the interference in a clearance analysis data set.

Interferences are stored as object pairs. Start the cycling using NULL as the input values for both object1 and object2. This routine passes back the tags of the objects that define the next interference. NULL returned for either object indicates the end of the cycling.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object in the pair of the current interference
object2	the second object in the pair of the current interference
nextObject1	the first object in the pair of the next interference
nextObject2	the second object in the pair of the next interference

int NXOpen::Assemblies::ClearanceSet::GetNumberOfInterferences ( )

Inquires the number of interferences stored in a clearance analysis data set.

If clearance analysis has never been run on the data set, an error is returned.

Returns: the number of interferences associated with the dataset
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::ClearanceSet::Summary NXOpen::Assemblies::ClearanceSet::GetResults ( )

Inquires a summary of the results of the most recent clearance analysis run.

   The @link Assemblies::ClearanceSet::Summary Assemblies::ClearanceSet::Summary@endlink  structure is 
   filled with analysis statistics, including numbers of objects, number of pairs,
   number of checked pairs, and number of interferences of each type. If
   clearance analysis has never been run on the data set, an error is
   returned.  @return  the summary structure

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

int NXOpen::Assemblies::ClearanceSet::GetVersion ( )

Gets the version of a clearance analysis dataset.

The version indicates how many times clearance analysis has been run on a data set. If the version is zero, then the analysis has never been run.

Returns: Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Assemblies::ClearanceSet::PerformAnalysis ( NXOpen::Assemblies::ClearanceSet::ReanalyzeOutOfDateExcludedPairs reanalyzeOption )

Perform an analysis on this clearance set with option to specify whether out-of-date excluded pairs will be reanalyzed.

You can specify to use the Customer Default setting, or you can specify a true or false option to override the Customer Default.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

reanalyzeOption reanalyzeoption

void NXOpen::Assemblies::ClearanceSet::ReanalyzePairs	(	const std::vector< NXOpen::DisplayableObject * > &	firstObjects,
		const std::vector< NXOpen::DisplayableObject * > &	secondObjects,
		NXOpen::Assemblies::ClearanceSet::ReanalyzePairCalculationMethod	calculationMethod
	)

Reanalyze a set of interferences using the specified analysis method.

The interferences must be specified using two parallel arrays: the objects in the first interference should be given in the first elements of the arrays, the objects in the second interference should be given in the second elements of the arrays, etc.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

firstObjects	The first object of each interference. Must be the same size as secondObjects.
secondObjects	The second object of each interference. Must be the same size as firstObjects.
calculationMethod	calculationmethod

void NXOpen::Assemblies::ClearanceSet::SetInterferenceText	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		const NXString &	text
	)

Associates a text string to an interfering object pair.

Both objects must be members of the given dataset. If the object pair does not refer to an existing interference, an error is returned.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object in the pair
object2	the second object in the pair
text	the name of the new dataset NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ClearanceSet::SetInterferenceText	(	NXOpen::DisplayableObject *	object1,
		NXOpen::DisplayableObject *	object2,
		const char *	text
	)

Associates a text string to an interfering object pair.

Both objects must be members of the given dataset. If the object pair does not refer to an existing interference, an error is returned.
Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

object1	the first object in the pair
object2	the second object in the pair
text	the name of the new dataset NOTE: The full Unicode character set is not supported for this parameter.

The documentation for this class was generated from the following file:

Assemblies_ClearanceSet.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation