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

Represents a FeatureTeaching Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateFeatureTeaching

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::CAM::FeatureTeaching:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RuleMatchOptionType { RuleMatchOptionTypePmiConds = 1, RuleMatchOptionTypeGeomAttrs, RuleMatchOptionTypeGeomNames = 4, RuleMatchOptionTypeFaceColors = 8 }
 Rule Option types. More...
 

Public Member Functions

void AddNewFeatureType (const NXString &name, const NXString &superName)
 Adds a new feature type
Created in NX8.0.0. More...
 
void AddNewFeatureType (const char *name, const char *superName)
 Adds a new feature type
Created in NX8.0.0. More...
 
void AddNewRule (const NXString &name, const NXString &libraryPath, const NXString &featureTypeName)
 Adds a new rule
Created in NX8.0.0. More...
 
void AddNewRule (const char *name, const char *libraryPath, const char *featureTypeName)
 Adds a new rule
Created in NX8.0.0. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetFaces ()
 Gets the selected faces. More...
 
NXString GetRulePath ()
 Gets the selected rule path. More...
 
void RemoveFeatureType (const NXString &name)
 Removes a feature type
Created in NX8.0.0. More...
 
void RemoveFeatureType (const char *name)
 Removes a feature type
Created in NX8.0.0. More...
 
void RemoveRule (const NXString &path)
 Removes a rule
Created in NX8.0.0. More...
 
void RemoveRule (const char *path)
 Removes a rule
Created in NX8.0.0. More...
 
void RenameFeatureType (const NXString &name, const NXString &newName)
 Renames a feature type
Created in NX8.0.0. More...
 
void RenameFeatureType (const char *name, const char *newName)
 Renames a feature type
Created in NX8.0.0. More...
 
void RenameRule (const NXString &path, const NXString &newName)
 Renames a rule
Created in NX8.0.0. More...
 
void RenameRule (const char *path, const char *newName)
 Renames a rule
Created in NX8.0.0. More...
 
NXOpen::CAM::FeatureTeaching::RuleMatchOptionType RuleMatchOptions ()
 Returns the rule options
Created in NX8.0.0. More...
 
void SetFaces (const std::vector< NXOpen::DisplayableObject * > &aFaces)
 Sets the selected faces
Created in NX8.0.0. More...
 
void SetRuleMatchOptions (NXOpen::CAM::FeatureTeaching::RuleMatchOptionType options)
 Sets the rule options
Created in NX8.0.0. More...
 
void SetRulePath (const NXString &path)
 Sets the selected rule path
Created in NX8.0.0. More...
 
void SetRulePath (const char *path)
 Sets the selected rule path
Created in NX8.0.0. More...
 
void Teach ()
 Teaches the new feature
Created in NX8.0.0. More...
 
std::vector
< NXOpen::CAM::CAMFeature * > 
Test ()
 Tests the new feature. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a FeatureTeaching Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateFeatureTeaching

Created in NX8.0.0.


Member Enumeration Documentation

Rule Option types.

Enumerator
RuleMatchOptionTypeGeomAttrs 

geom attrs

Member Function Documentation

void NXOpen::CAM::FeatureTeaching::AddNewFeatureType ( const NXString name,
const NXString superName 
)

Adds a new feature type
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
superNamesuper name
void NXOpen::CAM::FeatureTeaching::AddNewFeatureType ( const char *  name,
const char *  superName 
)

Adds a new feature type
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
superNamesuper name
void NXOpen::CAM::FeatureTeaching::AddNewRule ( const NXString name,
const NXString libraryPath,
const NXString featureTypeName 
)

Adds a new rule
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
libraryPathlibrary path
featureTypeNamefeature type name
void NXOpen::CAM::FeatureTeaching::AddNewRule ( const char *  name,
const char *  libraryPath,
const char *  featureTypeName 
)

Adds a new rule
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
libraryPathlibrary path
featureTypeNamefeature type name
std::vector<NXOpen::DisplayableObject *> NXOpen::CAM::FeatureTeaching::GetFaces ( )

Gets the selected faces.

Returns

Created in NX8.0.0.

License requirements : fbm_author ("FBM Author")
NXString NXOpen::CAM::FeatureTeaching::GetRulePath ( )

Gets the selected rule path.

Returns

Created in NX8.0.0.

License requirements : fbm_author ("FBM Author")
void NXOpen::CAM::FeatureTeaching::RemoveFeatureType ( const NXString name)

Removes a feature type
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
void NXOpen::CAM::FeatureTeaching::RemoveFeatureType ( const char *  name)

Removes a feature type
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
void NXOpen::CAM::FeatureTeaching::RemoveRule ( const NXString path)

Removes a rule
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
pathpath
void NXOpen::CAM::FeatureTeaching::RemoveRule ( const char *  path)

Removes a rule
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
pathpath
void NXOpen::CAM::FeatureTeaching::RenameFeatureType ( const NXString name,
const NXString newName 
)

Renames a feature type
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
newNamenew name
void NXOpen::CAM::FeatureTeaching::RenameFeatureType ( const char *  name,
const char *  newName 
)

Renames a feature type
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
namename
newNamenew name
void NXOpen::CAM::FeatureTeaching::RenameRule ( const NXString path,
const NXString newName 
)

Renames a rule
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
pathpath
newNamenew name
void NXOpen::CAM::FeatureTeaching::RenameRule ( const char *  path,
const char *  newName 
)

Renames a rule
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
pathpath
newNamenew name
NXOpen::CAM::FeatureTeaching::RuleMatchOptionType NXOpen::CAM::FeatureTeaching::RuleMatchOptions ( )

Returns the rule options
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

void NXOpen::CAM::FeatureTeaching::SetFaces ( const std::vector< NXOpen::DisplayableObject * > &  aFaces)

Sets the selected faces
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
aFacesa faces
void NXOpen::CAM::FeatureTeaching::SetRuleMatchOptions ( NXOpen::CAM::FeatureTeaching::RuleMatchOptionType  options)

Sets the rule options
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
optionsoptions
void NXOpen::CAM::FeatureTeaching::SetRulePath ( const NXString path)

Sets the selected rule path
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
pathpath
void NXOpen::CAM::FeatureTeaching::SetRulePath ( const char *  path)

Sets the selected rule path
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

Parameters
pathpath
void NXOpen::CAM::FeatureTeaching::Teach ( )

Teaches the new feature
Created in NX8.0.0.



License requirements : fbm_author ("FBM Author")

std::vector<NXOpen::CAM::CAMFeature *> NXOpen::CAM::FeatureTeaching::Test ( )

Tests the new feature.

Returns

Created in NX8.0.0.

License requirements : fbm_author ("FBM Author")

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