NXOpen.CAE.FTK.ExportFilesParameter Class Reference

Represents the parameter settings for exporting data to external files. More...

Inheritance diagram for NXOpen.CAE.FTK.ExportFilesParameter:

Public Types
enum	HeaderOptions {   FileDescription, General, Abscissa, Ordinate,   AbscissaZ, ApplicationSpecific }
	Defines the header options More...
enum	OverrideOption { Rename, Append, Replace, Skip }
	Defines the expor behavior when file is exist More...

Public Member Functions
unsafe string[]	GetCustomRecordNames ()
	Gets the custom record names for export More...
unsafe string[]	GetFileNames ()
	Gets the external files for export More...
unsafe bool	GetIsCertainHeaderExportRequired (NXOpen.CAE.FTK.ExportFilesParameter.HeaderOptions whichHeader)
	Asks whether to export the specified header option More...
unsafe void	SetCustomRecordNames (string[] customRecordNames)
	Sets the custom record names for export More...
unsafe void	SetFileNames (string[] fileNames)
	Sets the external files for export More...
unsafe void	SetIsCertainHeaderExportRequired (NXOpen.CAE.FTK.ExportFilesParameter.HeaderOptions whichHeader, bool required)
	Sets whether or not a specific header is required More...
Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
new 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...

Protected Member Functions
override void	FreeResource ()
	Destroys the object More...

Properties
unsafe bool	IsHeaderExportRequired [get, set]
	Returns or sets the full header print required. More...
unsafe NXOpen.CAE.NumberFormat	NumberFormat [get]
	Returns the number format options. More...
unsafe NXOpen.CAE.FTK.ExportFilesParameter.OverrideOption	OverrideSetting [get, set]
	Returns or sets the file override option More...
Properties inherited from NXOpen.TransientObject
IntPtr	Handle [get]
	Handle of the internal object represented by this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Detailed Description

Represents the parameter settings for exporting data to external files.

This is an abstract class

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.CAE.FTK.ExportFilesParameter.HeaderOptions

Defines the header options

Enumerator
FileDescription
General
Abscissa
Ordinate
AbscissaZ
ApplicationSpecific

enum NXOpen.CAE.FTK.ExportFilesParameter.OverrideOption

Defines the expor behavior when file is exist

Enumerator
Rename	Rename the file name with number postfix, like A -> A1
Append	Append data to the end of the given file
Replace	Replace the whole data in the given file
Skip	Skip to write data

Member Function Documentation

override void NXOpen.CAE.FTK.ExportFilesParameter.FreeResource ( )

inlineprotectedvirtual

Destroys the object

Created in NX1847.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe string [] NXOpen.CAE.FTK.ExportFilesParameter.GetCustomRecordNames ( )

inline

Gets the custom record names for export

Created in NX1847.0.0

License requirements: None.

Returns

unsafe string [] NXOpen.CAE.FTK.ExportFilesParameter.GetFileNames ( )

inline

Gets the external files for export

Created in NX1847.0.0

License requirements: None.

Returns

unsafe bool NXOpen.CAE.FTK.ExportFilesParameter.GetIsCertainHeaderExportRequired ( NXOpen.CAE.FTK.ExportFilesParameter.HeaderOptions  whichHeader )

inline

Asks whether to export the specified header option

Created in NX1899.0.0

License requirements: None.

Parameters

whichHeader

Returns

unsafe void NXOpen.CAE.FTK.ExportFilesParameter.SetCustomRecordNames ( string[]  customRecordNames )

inline

Sets the custom record names for export

Created in NX1847.0.0

License requirements: None.

Parameters

customRecordNames

unsafe void NXOpen.CAE.FTK.ExportFilesParameter.SetFileNames ( string[]  fileNames )

inline

Sets the external files for export

Created in NX1847.0.0

License requirements: None.

Parameters

fileNames

unsafe void NXOpen.CAE.FTK.ExportFilesParameter.SetIsCertainHeaderExportRequired ( NXOpen.CAE.FTK.ExportFilesParameter.HeaderOptions  whichHeader, bool  required  )

inline

Sets whether or not a specific header is required

Created in NX1899.0.0

License requirements: None.

Parameters

whichHeader
required

Property Documentation

unsafe bool NXOpen.CAE.FTK.ExportFilesParameter.IsHeaderExportRequired

getset

Returns or sets the full header print required.

If the setting is true, all header options are required for export.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.NumberFormat NXOpen.CAE.FTK.ExportFilesParameter.NumberFormat

get

Returns the number format options.

The NumberFormat object will be deleted along with the file parameter object.

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.CAE.FTK.ExportFilesParameter.OverrideOption NXOpen.CAE.FTK.ExportFilesParameter.OverrideSetting

getset

Returns or sets the file override option

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

---

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

• CAE_FTK_ExportFilesParameter.cs