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

Inheritance diagram for NXOpen.CAE.CorrelFrfSolution:

Public Types
enum	OptionsSelectedCommand { Ref, Work, Overlay, Frac, FRACColorBar, FRACComparision }
	Indicates if the user wants to plot a Ref, Work or Overlay. More...

Public Member Functions
unsafe NXOpen.CAE.CorrelFrfSolution	CloneFrfCorrelation ()
	Make a clone of a frf correl solution. More...

unsafe NXOpen.CAE.FrfPairingFilterBuilder	CreateFrfPairingFilterBuilder ()
	Creates the Frf Pairing Filter builder object More...

unsafe NXOpen.CAE.PlotFrfOptionsBuilder	CreatePlotFrfOptionsBuilder (NXOpen.CAE.PlotFrfOptions plotFrfOptions)
	Creates the builder object for the Plot Frf Options editing More...

unsafe void	ExportFrfPairsToCsvFile (string filename)
	Exports an Frf Pair to a Csv file with default options More...

unsafe void	FrfPairingRemoveAllFilters ()
	Remove all Frf Pairing Filters More...

unsafe void	FrfPairingRemoveFilter (string name)
	Remove an Frf Pairing Filter More...

unsafe void	FrfPlotAddPair (int frfWorkExcitationNode, int frfWorkResponseNode, int frfRefExcitationNode, int frfRefResponseNode, int frfRefResponseDof, int frfRefExcitationDof)
	Add Frf Pairs for plotting More...

unsafe void	FrfPlotDoPlot ()
	Do an Frf Plotting More...

unsafe void	FrfPlotSetupPlotting (NXOpen.CAE.CorrelFrfSolution.OptionsSelectedCommand cmd)
	Setup an Frf Plotting More...

unsafe void	FrfPlotSetViewportDeviceAndIndex (int device, int viewIndex)
	Set the viewport information More...

unsafe void	SelectAllFrfPairs ()
	Select all Frf Pairs More...

unsafe void	ShowFrfInformation (bool reference)
	Shows the FRF Information appropriate to the reference or work solution More...

unsafe void	ShowFrfPairingFilterInformation (NXOpen.CAE.FrfPairingFilter filter)
	Show FRF pairing Filter information. More...

unsafe void	ShowFrfPairsInformation ()
	Show FRF pairs information. More...

Public Member Functions inherited from NXOpen.CAE.CorrelBaseSolution
unsafe void	ClearNodeMapNodes (int[] removeWorkNodes)
	Clear selected node map nodes More...

unsafe void	CreateDofSet (NXOpen.CAE.ISensorSet sensorSet, bool modifyNodeDisplacementCsys)
	Create dof set from sensor set More...

unsafe void	CreateGroupFromSensorSet (NXOpen.CAE.ISensorSet sensorSet)
	Create dof set from sensor set More...

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

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

unsafe void	GenerateDofSet ()
	Generate dof set More...

unsafe string	GetName ()
	Returns the correlation base solution name More...

unsafe NXOpen.CAE.SensorSetMgr	GetSensorSetMgr ()
	Get the sensor set manager More...

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

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

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

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

unsafe void	ShowInfo ()
	Show information. More...

unsafe void	ShowNodeMapInfo ()
	Show node map information. More...

unsafe void	UpdateNodeMap ()
	Update correlation base solution node matchings More...

unsafe void	UpdateResultsForSol (NXOpen.CAE.SimSolution sol, bool ignoreReload)
	Update results for solution More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator 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	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	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.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator 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 NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

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

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean 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 int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. 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 string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

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

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. 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 string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

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

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

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. 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 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 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 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 bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. 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 NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. 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 NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. 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 void	Print ()
	Prints a representation of this object to the system log file. 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	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 void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. 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 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 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	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	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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.CorrelFrfSolution , 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 NX1872.0.0

Member Enumeration Documentation

enum NXOpen.CAE.CorrelFrfSolution.OptionsSelectedCommand

Indicates if the user wants to plot a Ref, Work or Overlay.

Enumerator
Ref
Work
Overlay
Frac
FRACColorBar
FRACComparision

Member Function Documentation

unsafe NXOpen.CAE.CorrelFrfSolution NXOpen.CAE.CorrelFrfSolution.CloneFrfCorrelation ( )

inline

Make a clone of a frf correl solution.

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

Returns: Cloned solution

unsafe NXOpen.CAE.FrfPairingFilterBuilder NXOpen.CAE.CorrelFrfSolution.CreateFrfPairingFilterBuilder ( )

inline

Creates the Frf Pairing Filter builder object

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

Returns

unsafe NXOpen.CAE.PlotFrfOptionsBuilder NXOpen.CAE.CorrelFrfSolution.CreatePlotFrfOptionsBuilder ( NXOpen.CAE.PlotFrfOptions plotFrfOptions )

inline

Creates the builder object for the Plot Frf Options editing

Created in NX1872.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

plotFrfOptions

Returns

unsafe void NXOpen.CAE.CorrelFrfSolution.ExportFrfPairsToCsvFile ( string filename )

inline

Exports an Frf Pair to a Csv file with default options

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

filename

unsafe void NXOpen.CAE.CorrelFrfSolution.FrfPairingRemoveAllFilters ( )

inline

Remove all Frf Pairing Filters

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelFrfSolution.FrfPairingRemoveFilter ( string name )

inline

Remove an Frf Pairing Filter

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

name

unsafe void NXOpen.CAE.CorrelFrfSolution.FrfPlotAddPair	(	int	frfWorkExcitationNode,
		int	frfWorkResponseNode,
		int	frfRefExcitationNode,
		int	frfRefResponseNode,
		int	frfRefResponseDof,
		int	frfRefExcitationDof
	)

inline

Add Frf Pairs for plotting

Created in NX1872.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

frfWorkExcitationNode
frfWorkResponseNode
frfRefExcitationNode
frfRefResponseNode
frfRefResponseDof
frfRefExcitationDof

unsafe void NXOpen.CAE.CorrelFrfSolution.FrfPlotDoPlot ( )

inline

Do an Frf Plotting

Created in NX1872.0.0

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelFrfSolution.FrfPlotSetupPlotting ( NXOpen.CAE.CorrelFrfSolution.OptionsSelectedCommand cmd )

inline

Setup an Frf Plotting

Created in NX1872.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

cmd

unsafe void NXOpen.CAE.CorrelFrfSolution.FrfPlotSetViewportDeviceAndIndex	(	int	device,
		int	viewIndex
	)

inline

Set the viewport information

Created in NX1872.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

device
viewIndex

unsafe void NXOpen.CAE.CorrelFrfSolution.SelectAllFrfPairs ( )

inline

Select all Frf Pairs

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

unsafe void NXOpen.CAE.CorrelFrfSolution.ShowFrfInformation ( bool reference )

inline

Shows the FRF Information appropriate to the reference or work solution

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

reference

unsafe void NXOpen.CAE.CorrelFrfSolution.ShowFrfPairingFilterInformation ( NXOpen.CAE.FrfPairingFilter filter )

inline

Show FRF pairing Filter information.

Created in NX1899.0.0

License requirements: nx_correl_base ("FE Correlation")

Parameters

filter

unsafe void NXOpen.CAE.CorrelFrfSolution.ShowFrfPairsInformation ( )

inline

Show FRF pairs information.

Created in NX1872.0.0

License requirements: nx_correl_base ("FE Correlation")

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

CAE_CorrelFrfSolution.cs

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation