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

Represents a command importer to import the commands into command libary. More...

Inheritance diagram for NXOpen::Report::CommandImporter:
NXOpen::TransientObject

Public Types

enum  OverrideOption { OverrideOptionIgnore, OverrideOptionReplace, OverrideOptionCopy }
 Represents the override option when there is already a command existing. More...
 

Public Member Functions

void GetImportCandidates (std::vector< NXOpen::Report::Command * > &pCommands)
 Gets all candidate commands in library file. More...
 
void ImportCommands (const std::vector< int > &pCommandIndexes)
 Imports the selected commands into command library. More...
 
NXOpen::Report::CommandImporter::OverrideOption ImportOption ()
 Returns the command override option. More...
 
void SetImportOption (NXOpen::Report::CommandImporter::OverrideOption importOption)
 Sets the command override option. More...
 
virtual ~CommandImporter ()
 Destroys the object
Created in NX11.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 a command importer to import the commands into command libary.


Created in NX11.0.0.

Member Enumeration Documentation

Represents the override option when there is already a command existing.

Enumerator
OverrideOptionIgnore 

No action, do not import to library.

OverrideOptionReplace 

Import to replace the existing one.

OverrideOptionCopy 

Import and append a new one.

Constructor & Destructor Documentation

virtual NXOpen::Report::CommandImporter::~CommandImporter ( )
virtual

Destroys the object
Created in NX11.0.0.



License requirements : None

Member Function Documentation

void NXOpen::Report::CommandImporter::GetImportCandidates ( std::vector< NXOpen::Report::Command * > &  pCommands)

Gets all candidate commands in library file.


Created in NX11.0.0.

License requirements : None

Parameters
pCommandspcommands
void NXOpen::Report::CommandImporter::ImportCommands ( const std::vector< int > &  pCommandIndexes)

Imports the selected commands into command library.


Created in NX11.0.0.

License requirements : None

Parameters
pCommandIndexespcommandindexes
NXOpen::Report::CommandImporter::OverrideOption NXOpen::Report::CommandImporter::ImportOption ( )

Returns the command override option.


Created in NX11.0.0.

License requirements : None

void NXOpen::Report::CommandImporter::SetImportOption ( NXOpen::Report::CommandImporter::OverrideOption  importOption)

Sets the command override option.


Created in NX11.0.0.

License requirements : None

Parameters
importOptionimportoption

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