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

Represents the command manager. More...

Public Member Functions

NXOpen::Report::CommandBuilderCreateCommandBuilder (NXOpen::Report::CommandLibrary *commandLibrary, NXOpen::Report::Command *command)
 Creates the command builder. More...
 
void ExportCommandsToLibraryFile (const std::vector< NXOpen::Report::Command * > &pCommands, const NXString &libraryFile)
 Export selected commands to a library folder zip file. More...
 
void ExportCommandsToLibraryFile (const std::vector< NXOpen::Report::Command * > &pCommands, const char *libraryFile)
 Export selected commands to a library folder zip file. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the TaggedObject with the given identifier as recorded in a journal. More...
 
void GetCommandLibraries (std::vector< NXOpen::Report::CommandLibrary * > &pCommandLibraries)
 Gets all command libraries. More...
 
NXOpen::Report::CommandImporterNewCommandImporter (NXOpen::Report::CommandLibrary *pCommandLibrary, const NXString &libraryFile)
 Creates a transient object NXOpen::Report::CommandImporter to import the selected commands of a command library file to a command library. More...
 
NXOpen::Report::CommandImporterNewCommandImporter (NXOpen::Report::CommandLibrary *pCommandLibrary, const char *libraryFile)
 Creates a transient object NXOpen::Report::CommandImporter to import the selected commands of a command library file to a command library. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the command manager.


Not support KF.

Created in NX11.0.0.

Member Function Documentation

NXOpen::Report::CommandBuilder* NXOpen::Report::CommandManager::CreateCommandBuilder ( NXOpen::Report::CommandLibrary commandLibrary,
NXOpen::Report::Command command 
)

Creates the command builder.

Returns

Created in NX11.0.0.

License requirements : None
Parameters
commandLibrarycommandlibrary
commandcommand
void NXOpen::Report::CommandManager::ExportCommandsToLibraryFile ( const std::vector< NXOpen::Report::Command * > &  pCommands,
const NXString libraryFile 
)

Export selected commands to a library folder zip file.


Created in NX11.0.0.

License requirements : None

Parameters
pCommandspcommands
libraryFileLibrary folder zip file name with full path
void NXOpen::Report::CommandManager::ExportCommandsToLibraryFile ( const std::vector< NXOpen::Report::Command * > &  pCommands,
const char *  libraryFile 
)

Export selected commands to a library folder zip file.


Created in NX11.0.0.

License requirements : None

Parameters
pCommandspcommands
libraryFileLibrary folder zip file name with full path
NXOpen::TaggedObject* NXOpen::Report::CommandManager::Find ( const NXString journalIdentifier)

Finds the TaggedObject with the given identifier as recorded in a journal.

Returns
Object found, or null if no such object exists
Created in NX11.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the TaggedObject to be found
NXOpen::TaggedObject* NXOpen::Report::CommandManager::Find ( const char *  journalIdentifier)

Finds the TaggedObject with the given identifier as recorded in a journal.

Returns
Object found, or null if no such object exists
Created in NX11.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the TaggedObject to be found
void NXOpen::Report::CommandManager::GetCommandLibraries ( std::vector< NXOpen::Report::CommandLibrary * > &  pCommandLibraries)

Gets all command libraries.


Created in NX11.0.0.

License requirements : None

Parameters
pCommandLibrariespcommandlibraries
NXOpen::Report::CommandImporter* NXOpen::Report::CommandManager::NewCommandImporter ( NXOpen::Report::CommandLibrary pCommandLibrary,
const NXString libraryFile 
)

Creates a transient object NXOpen::Report::CommandImporter to import the selected commands of a command library file to a command library.

The object should be destroyed after finishing import.

Returns

Created in NX11.0.0.

License requirements : None
Parameters
pCommandLibrarypcommandlibrary
libraryFileLibrary folder zip file name with full path
NXOpen::Report::CommandImporter* NXOpen::Report::CommandManager::NewCommandImporter ( NXOpen::Report::CommandLibrary pCommandLibrary,
const char *  libraryFile 
)

Creates a transient object NXOpen::Report::CommandImporter to import the selected commands of a command library file to a command library.

The object should be destroyed after finishing import.

Returns

Created in NX11.0.0.

License requirements : None
Parameters
pCommandLibrarypcommandlibrary
libraryFileLibrary folder zip file name with full path
tag_t NXOpen::Report::CommandManager::Tag ( ) const

Returns the tag of this object.


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