Represents a NXOpen.CAE.CorrelSolution , which is a meta-solution used to compare results from two structural dynamics solutions More...

Inheritance diagram for NXOpen.CAE.CorrelSolution:

Public Member Functions
unsafe NXOpen.CAE.CorrelModePairingBuilder	CreateModePairingBuilder ()
	Creates the builder object for mode pairing editing More...

unsafe string	GetSolutionName ()
	Returns the correlation solution name More...

unsafe void	SetSolutionName (string solutionName, bool renameResultFile)
	Sets the correlation solution name More...

unsafe void	Destroy (bool deleteResultFile)
	Deletes a correlation solution More...

unsafe double[]	ComputeMacs (out double[] referenceModeFrequencies, out int[] referenceModeNumbers, out double[] workModeFrequencies, out int[] workModeNumbers)
	Computes the Model Assurance Criterion (MAC) correlation metric for active modes More...

unsafe double[]	CalculateComacs (out int[] referenceModeNumbers, out int[] workModeNumbers, out double[] referenceModeFrequencies, out double[] workModeFrequencies, out int[] refNodesHaveSensors, out int[] refNodeIndex, out int[] refDofIndex)
	Computes the CoMAC correlation metric for active modes More...

unsafe void	SetActiveRefMode (int refModeNumber, bool active)
	Sets a specific reference mode as active or not More...

unsafe void	SetActiveWorkMode (int workModeNumber, bool active)
	Sets a specific work mode as active or not More...

unsafe void	SetActiveModePair (int referenceModeNumber, int workModeNumber, bool active)
	Sets a specific mode pair as active or not More...

unsafe void	SetActiveSensor (int sensorNumber, bool active)
	Sets a specific sensor as active or not More...

unsafe void	SetActiveSensorDof (int sensorNumber, int dofNumber, bool active)
	Sets a specific sensor DOF as active or not More...

unsafe void	SetActiveSensorDofOrientation (int sensorNumber, int dofNumber, bool orientation)
	Sets a specific sensor DOF orientation More...

unsafe void	ExportModePairCsvFile (string filename)
	Export mode pair to CSV file More...

unsafe void	ExportShapeMetricsCsvFile (NXOpen.CAE.CorrelShapemetrictype metricCode, string filename)
	Export shape metrics to CSV file More...

unsafe void	UpdateNodeMatchings ()
	Update correlation node matchings More...

unsafe void	ComputeModePairsForSol ()
	Compute mode pairs for correlation solution More...

unsafe NXOpen.CAE.CorrelSolution	CloneCorrelation ()
	Make a clone of a correl solution. More...

unsafe void	UpdateResultsForSolution (NXOpen.CAE.SimSolution tSolution, bool ignoreReload)
	Update results for correlation solution More...

unsafe void	GenerateMatchingDofset ()
	Create Matching DOFSet More...

unsafe void	GenerateComacResults ()
	Create COMAC results More...

unsafe void	ImportNodeMapCsvFile (string filename)
	Import node map CSV file More...

unsafe void	ExportNodeMapCsvFile (string filename)
	Export node map to CSV file More...

unsafe void	LockNodeMap ()
	Lock the node map. More...

unsafe void	UnlockNodeMap ()
	Unlock the node map. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

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

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

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

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string 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. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe string	GetUserAttributeAsString (string 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. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

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

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

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

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

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

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

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

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

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

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

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

Additional Inherited Members
Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Detailed Description

Represents a NXOpen.CAE.CorrelSolution , which is a meta-solution used to compare results from two structural dynamics solutions

To create or edit an instance of this class, use NXOpen.CAE.CorrelSolutionBuilder

Created in NX6.0.0

Member Function Documentation

unsafe double [] NXOpen.CAE.CorrelSolution.CalculateComacs	(	out int[]	referenceModeNumbers,
		out int[]	workModeNumbers,
		out double[]	referenceModeFrequencies,
		out double[]	workModeFrequencies,
		out int[]	refNodesHaveSensors,
		out int[]	refNodeIndex,
		out int[]	refDofIndex
	)

Computes the CoMAC correlation metric for active modes

Created in NX6.0.2

License requirements: nx_correl_base ("FE Correlation")

Parameters

referenceModeNumbers	reference mode numbers
workModeNumbers	work mode numbers
referenceModeFrequencies	reference mode frequencies
workModeFrequencies	work mode frequencies
refNodesHaveSensors	indicates if nodes have a sensor (0=yes, 1=no)
refNodeIndex	reference node index
refDofIndex	reference dof index

Returns: comac values

unsafe NXOpen.CAE.CorrelSolution NXOpen.CAE.CorrelSolution.CloneCorrelation ( )

Make a clone of a correl solution.

Created in NX8.0.1

License requirements: nx_correl_base ("FE Correlation")

Returns: Cloned solution

unsafe double [] NXOpen.CAE.CorrelSolution.ComputeMacs	(	out double[]	referenceModeFrequencies,
		out int[]	referenceModeNumbers,
		out double[]	workModeFrequencies,
		out int[]	workModeNumbers
	)

Computes the Model Assurance Criterion (MAC) correlation metric for active modes

Created in NX6.0.1

License requirements: nx_correl_base ("FE Correlation")

Parameters

referenceModeFrequencies	ref mode frequencies
referenceModeNumbers	ref mode numbers
workModeFrequencies	work mode frequencies
workModeNumbers	work mode numbers

Returns: the MAC values computed

unsafe void NXOpen.CAE.CorrelSolution.ComputeModePairsForSol ( )

Compute mode pairs for correlation solution

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

unsafe NXOpen.CAE.CorrelModePairingBuilder NXOpen.CAE.CorrelSolution.CreateModePairingBuilder ( )

Creates the builder object for mode pairing editing

Created in NX6.0.1

License requirements: nx_correl_base ("FE Correlation")

Returns

unsafe void NXOpen.CAE.CorrelSolution.Destroy ( bool deleteResultFile )

Deletes a correlation solution

Created in NX5.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

deleteResultFile delete the result files associated with the solution or not

unsafe void NXOpen.CAE.CorrelSolution.ExportModePairCsvFile ( string filename )

Export mode pair to CSV file

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

filename CSV file name.

unsafe void NXOpen.CAE.CorrelSolution.ExportNodeMapCsvFile ( string filename )

Export node map to CSV file

Created in NX9.0.1

License requirements: nx_correl_base ("FE Correlation")

Parameters

filename CSV file name.

unsafe void NXOpen.CAE.CorrelSolution.ExportShapeMetricsCsvFile	(	NXOpen.CAE.CorrelShapemetrictype	metricCode,
		string	filename
	)

Export shape metrics to CSV file

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

metricCode	shape metric code
filename	CSV file name.

unsafe void NXOpen.CAE.CorrelSolution.GenerateComacResults ( )

Create COMAC results

Created in NX7.5.1

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelSolution.GenerateMatchingDofset ( )

Create Matching DOFSet

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

unsafe string NXOpen.CAE.CorrelSolution.GetSolutionName ( )

Returns the correlation solution name

Created in NX5.0.0

License requirements: None.

Returns: the NXOpen.CAE.CorrelSolution name

unsafe void NXOpen.CAE.CorrelSolution.ImportNodeMapCsvFile ( string filename )

Import node map CSV file

Created in NX9.0.1

License requirements: nx_correl_base ("FE Correlation")

Parameters

filename CSV file name.

unsafe void NXOpen.CAE.CorrelSolution.LockNodeMap ( )

Lock the node map.

Created in NX11.0.0

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelSolution.SetActiveModePair	(	int	referenceModeNumber,
		int	workModeNumber,
		bool	active
	)

Sets a specific mode pair as active or not

Created in NX6.0.1

License requirements: nx_correl_base ("FE Correlation")

Parameters

referenceModeNumber	reference mode of the pair
workModeNumber	work mode of the pair
active	activate or deactivate flag

unsafe void NXOpen.CAE.CorrelSolution.SetActiveRefMode	(	int	refModeNumber,
		bool	active
	)

Sets a specific reference mode as active or not

Created in NX6.0.1

License requirements: nx_correl_base ("FE Correlation")

Parameters

refModeNumber	reference mode to activate or deactivate
active	activate or deactivate flag

unsafe void NXOpen.CAE.CorrelSolution.SetActiveSensor	(	int	sensorNumber,
		bool	active
	)

Sets a specific sensor as active or not

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

sensorNumber	sensor number
active	activate or deactivate flag

unsafe void NXOpen.CAE.CorrelSolution.SetActiveSensorDof	(	int	sensorNumber,
		int	dofNumber,
		bool	active
	)

Sets a specific sensor DOF as active or not

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

sensorNumber	sensor number
dofNumber	dof number
active	activate or deactivate flag

unsafe void NXOpen.CAE.CorrelSolution.SetActiveSensorDofOrientation	(	int	sensorNumber,
		int	dofNumber,
		bool	orientation
	)

Sets a specific sensor DOF orientation

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

sensorNumber	sensor number
dofNumber	dof number
orientation	true for positive orientation or false for negative orientation

unsafe void NXOpen.CAE.CorrelSolution.SetActiveWorkMode	(	int	workModeNumber,
		bool	active
	)

Sets a specific work mode as active or not

Created in NX6.0.1

License requirements: nx_correl_base ("FE Correlation")

Parameters

workModeNumber	work mode to activate or deactivate
active	activate or deactivate flag

unsafe void NXOpen.CAE.CorrelSolution.SetSolutionName	(	string	solutionName,
		bool	renameResultFile
	)

Sets the correlation solution name

Created in NX5.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

solutionName	new solution name
renameResultFile	if there are result files associated with the solution, rename the files or not

unsafe void NXOpen.CAE.CorrelSolution.UnlockNodeMap ( )

Unlock the node map.

Created in NX11.0.0

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelSolution.UpdateNodeMatchings ( )

Update correlation node matchings

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelSolution.UpdateResultsForSolution	(	NXOpen.CAE.SimSolution	tSolution,
		bool	ignoreReload
	)

Update results for correlation solution

Created in NX7.5.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

tSolution	solution
ignoreReload	ignore reload

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

dotnet_pool/CAE_CorrelSolution.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation