NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Report::ResultXmlFileWriter Class Reference

Contains methods for adding document data and generating result XML file for CAE Report. More...

Inheritance diagram for NXOpen::Report::ResultXmlFileWriter:
NXOpen::TransientObject

Public Member Functions

NXOpen::OpenXml::ImageGroupDocumentDataAddImageGroup ()
 Creates a new NXOpen::OpenXml::ImageGroupDocumentData object. More...
 
NXOpen::OpenXml::TableDocumentDataAddTable (int columnSize, int rowSize)
 Creates a new NXOpen::OpenXml::TableDocumentData object. More...
 
NXOpen::OpenXml::TextDocumentDataAddText (const NXString &textContent)
 Creates a new NXOpen::OpenXml::TextDocumentData object. More...
 
NXOpen::OpenXml::TextDocumentDataAddText (const char *textContent)
 Creates a new NXOpen::OpenXml::TextDocumentData object. More...
 
void DeleteAllData ()
 Removes all document data
Created in NX11.0.0. More...
 
void DeleteNthData (int index)
 Removes the nth document data
Created in NX11.0.0. More...
 
int GetDataCount ()
 Gets the number of data to be exported. More...
 
NXOpen::OpenXml::DocumentDataGetNthData (int index)
 Gets the nth document data object. More...
 
void SaveToFile (const NXString &fileName)
 Exports all document data to result XML file
Created in NX11.0.0. More...
 
void SaveToFile (const char *fileName)
 Exports all document data to result XML file
Created in NX11.0.0. More...
 
virtual ~ResultXmlFileWriter ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Contains methods for adding document data and generating result XML file for CAE Report.


Created in NX11.0.0.

Constructor & Destructor Documentation

virtual NXOpen::Report::ResultXmlFileWriter::~ResultXmlFileWriter ( )
virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX11.0.0.

License requirements : None

Member Function Documentation

NXOpen::OpenXml::ImageGroupDocumentData* NXOpen::Report::ResultXmlFileWriter::AddImageGroup ( )

Creates a new NXOpen::OpenXml::ImageGroupDocumentData object.

Does not to free this object, it will be free while deleting NXOpen::Report::ResultXmlFileWriter object

Returns
the image group data
Created in NX11.0.0.

License requirements : None
NXOpen::OpenXml::TableDocumentData* NXOpen::Report::ResultXmlFileWriter::AddTable ( int  columnSize,
int  rowSize 
)

Creates a new NXOpen::OpenXml::TableDocumentData object.

Does not to free this object, it will be free while deleting NXOpen::Report::ResultXmlFileWriter object

Returns
the table data
Created in NX11.0.0.

License requirements : None
Parameters
columnSizethe column size of the table
rowSizethe row size of the table
NXOpen::OpenXml::TextDocumentData* NXOpen::Report::ResultXmlFileWriter::AddText ( const NXString textContent)

Creates a new NXOpen::OpenXml::TextDocumentData object.

Does not to free this object, it will be free while deleting NXOpen::Report::ResultXmlFileWriter object

Returns
the text data
Created in NX11.0.0.

License requirements : None
Parameters
textContentthe content of the text data
NXOpen::OpenXml::TextDocumentData* NXOpen::Report::ResultXmlFileWriter::AddText ( const char *  textContent)

Creates a new NXOpen::OpenXml::TextDocumentData object.

Does not to free this object, it will be free while deleting NXOpen::Report::ResultXmlFileWriter object

Returns
the text data
Created in NX11.0.0.

License requirements : None
Parameters
textContentthe content of the text data
void NXOpen::Report::ResultXmlFileWriter::DeleteAllData ( )

Removes all document data
Created in NX11.0.0.



License requirements : None

void NXOpen::Report::ResultXmlFileWriter::DeleteNthData ( int  index)

Removes the nth document data
Created in NX11.0.0.



License requirements : None

Parameters
indexthe index of data
int NXOpen::Report::ResultXmlFileWriter::GetDataCount ( )

Gets the number of data to be exported.

Returns
the number of data
Created in NX11.0.0.

License requirements : None
NXOpen::OpenXml::DocumentData* NXOpen::Report::ResultXmlFileWriter::GetNthData ( int  index)

Gets the nth document data object.

Does not to free this object, it will be free while deleting NXOpen::Report::ResultXmlFileWriter object

Returns
the data
Created in NX11.0.0.

License requirements : None
Parameters
indexthe index of data
void NXOpen::Report::ResultXmlFileWriter::SaveToFile ( const NXString fileName)

Exports all document data to result XML file
Created in NX11.0.0.



License requirements : None

Parameters
fileNamethe file name to be exported
void NXOpen::Report::ResultXmlFileWriter::SaveToFile ( const char *  fileName)

Exports all document data to result XML file
Created in NX11.0.0.



License requirements : None

Parameters
fileNamethe file name to be exported

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.