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	OverrideOption { OverrideOptionRename, OverrideOptionAppend, OverrideOptionReplace, OverrideOptionSkip }
	Defines the expor behavior when file is exist. More...

Public Member Functions
std::vector< NXString >	GetCustomRecordNames ()
	Gets the custom record names for export Created in NX1847.0.0. More...
std::vector< NXString >	GetFileNames ()
	Gets the external files for export Created in NX1847.0.0. More...
bool	IsHeaderExportRequired ()
	Returns the header print required Created in NX1847.0.0. More...
NXOpen::CAE::NumberFormat *	NumberFormat ()
	Returns the number format options. More...
NXOpen::CAE::FTK::ExportFilesParameter::OverrideOption	OverrideSetting ()
	Returns the file override option Created in NX1847.0.0. More...
void	SetCustomRecordNames (std::vector< NXString > &customRecordNames)
	Sets the custom record names for export Created in NX1847.0.0. More...
void	SetFileNames (std::vector< NXString > &fileNames)
	Sets the external files for export Created in NX1847.0.0. More...
void	SetHeaderExportRequired (bool hasHeader)
	Sets the header print required Created in NX1847.0.0. More...
void	SetOverrideSetting (NXOpen::CAE::FTK::ExportFilesParameter::OverrideOption overrideOption)
	Sets the file override option Created in NX1847.0.0. More...
virtual	~ExportFilesParameter ()
	Destroys the object Created in NX1847.0.0. More...
Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. 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::OverrideOption

Defines the expor behavior when file is exist.

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

Constructor & Destructor Documentation

virtual NXOpen::CAE::FTK::ExportFilesParameter::~ExportFilesParameter ( )

virtual

Destroys the object
Created in NX1847.0.0.

License requirements : None

Member Function Documentation

std::vector<NXString> NXOpen::CAE::FTK::ExportFilesParameter::GetCustomRecordNames

(

)

Gets the custom record names for export
Created in NX1847.0.0.

License requirements : None

std::vector<NXString> NXOpen::CAE::FTK::ExportFilesParameter::GetFileNames

(

)

Gets the external files for export
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::FTK::ExportFilesParameter::IsHeaderExportRequired

(

)

Returns the header print required
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::NumberFormat* NXOpen::CAE::FTK::ExportFilesParameter::NumberFormat

(

)

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

NXOpen::CAE::FTK::ExportFilesParameter::OverrideOption NXOpen::CAE::FTK::ExportFilesParameter::OverrideSetting

(

)

Returns the file override option
Created in NX1847.0.0.

License requirements : None

void NXOpen::CAE::FTK::ExportFilesParameter::SetCustomRecordNames

(

std::vector< NXString > &

customRecordNames

)

Sets the custom record names for export
Created in NX1847.0.0.

License requirements : None

Parameters

customRecordNames

customrecordnames

void NXOpen::CAE::FTK::ExportFilesParameter::SetFileNames

(

std::vector< NXString > &

fileNames

)

Sets the external files for export
Created in NX1847.0.0.

License requirements : None

Parameters

fileNames

filenames

void NXOpen::CAE::FTK::ExportFilesParameter::SetHeaderExportRequired

(

bool

hasHeader

)

Sets the header print required
Created in NX1847.0.0.

License requirements : None

Parameters

hasHeader

hasheader

void NXOpen::CAE::FTK::ExportFilesParameter::SetOverrideSetting

(

NXOpen::CAE::FTK::ExportFilesParameter::OverrideOption

overrideOption

)

Sets the file override option
Created in NX1847.0.0.

License requirements : None

Parameters

overrideOption

overrideoption

---

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

• CAE_FTK_ExportFilesParameter.hxx