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

Represents Cutter Export Builder
Created in NX9.0.0. More...

Inheritance diagram for NXOpen::CAM::CutterExport:
NXOpen::TaggedObject

Public Types

enum  HolderExportStatus {
  HolderExportStatusOk, HolderExportStatusUnchanged, HolderExportStatusUndefined, HolderExportStatusUntried,
  HolderExportStatusFail
}
 the holder export status More...
 
enum  SaveFlags { SaveFlagsReplace, SaveFlagsCreateNew }
 the save flag options More...
 
enum  TrackpointExportStatus {
  TrackpointExportStatusOk, TrackpointExportStatusUnchanged, TrackpointExportStatusUndefined, TrackpointExportStatusUntried,
  TrackpointExportStatusFail
}
 the trackpoint export status More...
 

Public Member Functions

void Export ()
 The cutter export entry
Created in NX9.0.0. More...
 
void ExportHolder ()
 The holder export entry
Created in NX9.0.0. More...
 
NXOpen::CAM::CutterExport::HolderExportStatus GetHolderExportStatus ()
 The flag indicate export status of holder. More...
 
NXOpen::CAM::CutterExport::TrackpointExportStatus GetTrackpointExportStatus ()
 The flag indicate export status of trackpoint. More...
 
std::vector< NXStringGetValidAttributes (const NXString &targetClass)
 The valid attributes, target class in the builder needs to be set before this method is called. More...
 
std::vector< NXStringGetValidAttributes (const char *targetClass)
 The valid attributes, target class in the builder needs to be set before this method is called. More...
 
std::vector< NXStringGetValidTargetClasses (NXOpen::CAM::CutterExport::SaveFlags saveFlag, const NXString &replaceLibref)
 The valid target classes of the cutter. More...
 
std::vector< NXStringGetValidTargetClasses (NXOpen::CAM::CutterExport::SaveFlags saveFlag, const char *replaceLibref)
 The valid target classes of the cutter. More...
 
void GetValidValuesOfAttribute (const NXString &attr, std::vector< NXString > &valueIds, std::vector< NXString > &valueTexts)
 The valid values of certain attribute
Created in NX9.0.0. More...
 
void GetValidValuesOfAttribute (const char *attr, std::vector< NXString > &valueIds, std::vector< NXString > &valueTexts)
 The valid values of certain attribute
Created in NX9.0.0. More...
 
NXString HolderLibref ()
 Returns the libref of the export holder
Created in NX9.0.0. More...
 
NXOpen::CAM::CutterExport::SaveFlags HolderSaveFlag ()
 Returns the export type
Created in NX9.0.0. More...
 
NXString Libref ()
 Returns the libref of the export cutter
Created in NX9.0.0. More...
 
NXOpen::CAM::CutterExport::SaveFlags SaveFlag ()
 Returns the export type
Created in NX9.0.0. More...
 
void SetAttributeAndValue (std::vector< NXString > &attributes, std::vector< NXString > &values)
 The attributes and values
Created in NX9.0.0. More...
 
void SetHolderLibref (const NXString &libref)
 Sets the libref of the export holder
Created in NX9.0.0. More...
 
void SetHolderLibref (const char *libref)
 Sets the libref of the export holder
Created in NX9.0.0. More...
 
void SetHolderSaveFlag (NXOpen::CAM::CutterExport::SaveFlags saveFlag)
 Sets the export type
Created in NX9.0.0. More...
 
void SetLibref (const NXString &libref)
 Sets the libref of the export cutter
Created in NX9.0.0. More...
 
void SetLibref (const char *libref)
 Sets the libref of the export cutter
Created in NX9.0.0. More...
 
void SetSaveFlag (NXOpen::CAM::CutterExport::SaveFlags saveFlag)
 Sets the export type
Created in NX9.0.0. More...
 
void SetTargetClass (const NXString &targetClass)
 Sets the target class for exporting
Created in NX9.0.0. More...
 
void SetTargetClass (const char *targetClass)
 Sets the target class for exporting
Created in NX9.0.0. More...
 
NXString TargetClass ()
 Returns the target class for exporting
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents Cutter Export Builder
Created in NX9.0.0.


Member Enumeration Documentation

the holder export status

Enumerator
HolderExportStatusOk 

Holder has been export successfully.

HolderExportStatusUnchanged 

Holder in library unchanged.

HolderExportStatusUndefined 

Holder is not defined.

HolderExportStatusUntried 

Holder export didn't happen.

HolderExportStatusFail 

Holder export failed.

the save flag options

Enumerator
SaveFlagsReplace 

Replace the one exist in tool library.

SaveFlagsCreateNew 

Create a new entry in tool library.

the trackpoint export status

Enumerator
TrackpointExportStatusOk 

Trackpoint has been export successfully.

TrackpointExportStatusUnchanged 

Trackpoint in library unchanged.

TrackpointExportStatusUndefined 

Trackpoint is not defined.

TrackpointExportStatusUntried 

Trackpoint export didn't happen.

TrackpointExportStatusFail 

Trackpoint export failed.

Member Function Documentation

void NXOpen::CAM::CutterExport::Export ( )

The cutter export entry
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::CutterExport::ExportHolder ( )

The holder export entry
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::CutterExport::HolderExportStatus NXOpen::CAM::CutterExport::GetHolderExportStatus ( )

The flag indicate export status of holder.

Returns
The holder export status
Created in NX9.0.0.

License requirements : None
NXOpen::CAM::CutterExport::TrackpointExportStatus NXOpen::CAM::CutterExport::GetTrackpointExportStatus ( )

The flag indicate export status of trackpoint.

Returns
The trackpoint export status
Created in NX9.0.0.

License requirements : None
std::vector<NXString> NXOpen::CAM::CutterExport::GetValidAttributes ( const NXString targetClass)

The valid attributes, target class in the builder needs to be set before this method is called.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
targetClasstargetclass
std::vector<NXString> NXOpen::CAM::CutterExport::GetValidAttributes ( const char *  targetClass)

The valid attributes, target class in the builder needs to be set before this method is called.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
targetClasstargetclass
std::vector<NXString> NXOpen::CAM::CutterExport::GetValidTargetClasses ( NXOpen::CAM::CutterExport::SaveFlags  saveFlag,
const NXString replaceLibref 
)

The valid target classes of the cutter.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
saveFlagsaveflag
replaceLibrefreplacelibref
std::vector<NXString> NXOpen::CAM::CutterExport::GetValidTargetClasses ( NXOpen::CAM::CutterExport::SaveFlags  saveFlag,
const char *  replaceLibref 
)

The valid target classes of the cutter.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
saveFlagsaveflag
replaceLibrefreplacelibref
void NXOpen::CAM::CutterExport::GetValidValuesOfAttribute ( const NXString attr,
std::vector< NXString > &  valueIds,
std::vector< NXString > &  valueTexts 
)

The valid values of certain attribute
Created in NX9.0.0.



License requirements : None

Parameters
attrattr
valueIdsvalueids
valueTextsvaluetexts
void NXOpen::CAM::CutterExport::GetValidValuesOfAttribute ( const char *  attr,
std::vector< NXString > &  valueIds,
std::vector< NXString > &  valueTexts 
)

The valid values of certain attribute
Created in NX9.0.0.



License requirements : None

Parameters
attrattr
valueIdsvalueids
valueTextsvaluetexts
NXString NXOpen::CAM::CutterExport::HolderLibref ( )

Returns the libref of the export holder
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::CutterExport::SaveFlags NXOpen::CAM::CutterExport::HolderSaveFlag ( )

Returns the export type
Created in NX9.0.0.



License requirements : None

NXString NXOpen::CAM::CutterExport::Libref ( )

Returns the libref of the export cutter
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::CutterExport::SaveFlags NXOpen::CAM::CutterExport::SaveFlag ( )

Returns the export type
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::CutterExport::SetAttributeAndValue ( std::vector< NXString > &  attributes,
std::vector< NXString > &  values 
)

The attributes and values
Created in NX9.0.0.



License requirements : None

Parameters
attributesThe attributes
valuesThe values
void NXOpen::CAM::CutterExport::SetHolderLibref ( const NXString libref)

Sets the libref of the export holder
Created in NX9.0.0.



License requirements : None

Parameters
librefThe libref
void NXOpen::CAM::CutterExport::SetHolderLibref ( const char *  libref)

Sets the libref of the export holder
Created in NX9.0.0.



License requirements : None

Parameters
librefThe libref
void NXOpen::CAM::CutterExport::SetHolderSaveFlag ( NXOpen::CAM::CutterExport::SaveFlags  saveFlag)

Sets the export type
Created in NX9.0.0.



License requirements : None

Parameters
saveFlagThe export type
void NXOpen::CAM::CutterExport::SetLibref ( const NXString libref)

Sets the libref of the export cutter
Created in NX9.0.0.



License requirements : None

Parameters
librefThe libref
void NXOpen::CAM::CutterExport::SetLibref ( const char *  libref)

Sets the libref of the export cutter
Created in NX9.0.0.



License requirements : None

Parameters
librefThe libref
void NXOpen::CAM::CutterExport::SetSaveFlag ( NXOpen::CAM::CutterExport::SaveFlags  saveFlag)

Sets the export type
Created in NX9.0.0.



License requirements : None

Parameters
saveFlagThe export type
void NXOpen::CAM::CutterExport::SetTargetClass ( const NXString targetClass)

Sets the target class for exporting
Created in NX9.0.0.



License requirements : None

Parameters
targetClassThe target class
void NXOpen::CAM::CutterExport::SetTargetClass ( const char *  targetClass)

Sets the target class for exporting
Created in NX9.0.0.



License requirements : None

Parameters
targetClassThe target class
NXString NXOpen::CAM::CutterExport::TargetClass ( )

Returns the target class for exporting
Created in NX9.0.0.



License requirements : None


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