NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::CAM::CAMObject Class Reference

Represents interface for all CAM Object
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::CAM::CAMObject:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::CAM::CAMSetup NXOpen::CAM::InspectionGroup NXOpen::CAM::InspectionSetup NXOpen::CAM::Move NXOpen::CAM::NCGroup NXOpen::CAM::Operation NXOpen::CAM::TrackPoint NXOpen::CAM::InspectionTool NXOpen::CAM::InspectionMoveSubop NXOpen::CAM::ManualMove NXOpen::CAM::FeatureGeometry NXOpen::CAM::Method NXOpen::CAM::OrientGeometry NXOpen::CAM::Tool NXOpen::CAM::GenericMotionControl NXOpen::CAM::HoleMaking NXOpen::CAM::InspectionOperation NXOpen::CAM::LatheMachineControl NXOpen::CAM::MillMachineControl NXOpen::CAM::MillOperation NXOpen::CAM::ThreadMilling NXOpen::CAM::TurningOperation NXOpen::CAM::UserDefinedOpr NXOpen::CAM::WedmMachineControl NXOpen::CAM::SolidTrackPoint

List of all members.

Classes

struct  ErrorItem
 Error Item. More...

Public Types

enum  Attr {
  AttrProjDiffTaxis = 1, AttrProfileFlipMside, AttrBndSplineTangent, AttrBlankNormalDiffTaxis,
  AttrBndHasSleepObj, AttrClrnrNotParallelTaxis, AttrBndNotParallelFloor, AttrFloorNotUpToDate,
  AttrSingleProfileWithFirstCut, AttrCutterConversionProblem, AttrAcceptDrivePosition = 100, AttrReparametrization = 110,
  AttrBetweenFromStart = 120, AttrCurveCutRange = 130, AttrFixGssmCornerData = 140, AttrPlmConversion = 150,
  AttrPlmFeedcomp, AttrPlmFillet, AttrPlmSlowdown, AttrPlmGeometry,
  AttrWedmPoints = 160, AttrCavityMillInheritTrimBnds = 170, AttrRtdObsolete = 1000, AttrZlevelHolderParamChange = 2000,
  AttrNcmObsoleteSeqControl = 2100, AttrNcmObsoleteCustomFeed, AttrNcmObsoleteLocalRetract, AttrNcmClearTraversalZero,
  AttrNcmObsoleteEngretToClearance, AttrGmcInvalidNxVersion = 2201, AttrProbingInvalidNxVersion, AttrInspPathInvalidNxVersion = 2300,
  AttrCustomDataGougingObsolete, AttrCustomDataGougingPartObsolete, AttrCustomDataGougingDriveObsolete, AttrCustomDataIgnoreLoopsObsolete,
  AttrLimitToolRunOn = 2400
}
enum  FeedRateUnit { FeedRateUnitNone, FeedRateUnitPerMinute, FeedRateUnitPerRevolution }
 The unit of feed rate. More...
enum  Status { StatusComplete, StatusRepost, StatusRegen, StatusApproved = 4 }
 The status of the object. More...

Public Member Functions

bool GetBooleanValue (const NXString &title)
 Get the boolean value of the parameter index from the object.
NXOpen::CAM::CAMObject::FeedRateUnit GetFeedRate (const NXString &title, double *value)
 Get the feed rate value and unit of the parameter index from the object.
int GetFeedRateColor (const NXString &title)
 Get the feed rate color of the parameter index from the object.
std::vector< int > GetIntegerArrayValue (const NXString &title)
 Get the integer array value of the parameter index from the object.
int GetIntegerValue (const NXString &title)
 Get the integer value of the parameter index from the object.
NXOpen::NXObjectGetObject (const NXString &title)
 Get the object value of the parameter index from the object.
std::vector< NXOpen::NXObject * > GetObjectArrayValue (const NXString &title)
 Get the object array value of the parameter index from the object.
std::vector< double > GetRealArrayValue (const NXString &title)
 Get the real array value of the parameter index from the object.
double GetRealValue (const NXString &title)
 Get the real value of the parameter index from the object.
NXOpen::CAM::CAMObject::Status GetStatus ()
 Get the status of the input object.
std::vector< NXStringGetStringArrayValue (const NXString &title)
 Get the string array value of the parameter index from the object.
NXString GetStringValue (const NXString &title)
 Get the string value of the parameter index from the object.
int GetWireEdmFeedRate (const NXString &title, double *value)
 Get the feed rate value and side of the parameter index from the object, side is only used in wire edm.
bool Has911Attribute (NXOpen::CAM::CAMObject::Attr attrId)
 Check if a 911 attribute exists in an object.
void Remove911Attribute (NXOpen::CAM::CAMObject::Attr attrId)
 Remove a specific 911 attribute from an object.
void RemoveAll911Attributes ()
 Remove all 911 attributes from an object.
void SetBooleanValue (const NXString &title, bool value)
 Set a boolean value to the parameter index for the object.
void SetFeedRate (const NXString &title, double value, NXOpen::CAM::CAMObject::FeedRateUnit unit)
 Set feed rate value and unit to the parameter index for the object.
void SetFeedRateColor (const NXString &title, int value)
 Set feed rate display color to the parameter index for the object.
void SetIntegerArrayValue (const NXString &title, const std::vector< int > &value)
 Set integer array value to the parameter index for the object.
void SetIntegerValue (const NXString &title, int value)
 Set an integer value to the parameter index for the object.
void SetObject (const NXString &title, NXOpen::NXObject *value)
 Set a object to the parameter index for the object.
void SetObjectArrayValue (const NXString &title, const std::vector< NXOpen::NXObject * > &value)
 Set object array to the parameter index for the object
Created in NX4.0.0.
void SetRealArrayValue (const NXString &title, const std::vector< double > &value)
 Set real array to the parameter index for the object.
void SetRealValue (const NXString &title, double value)
 Set a real value to the parameter index for the object.
void SetStringArrayValue (const NXString &title, std::vector< NXString > &value)
 Set string array to the parameter index for the object
Created in NX4.0.0.
void SetStringValue (const NXString &title, const NXString &value)
 Set a string value to the parameter index for the object.
void SetWireEdmFeedRate (const NXString &title, double value, int side)
 Set feed rate value and side to the parameter index for the object, side is only used in wire edm.

Detailed Description

Represents interface for all CAM Object
Created in NX4.0.0.



Member Enumeration Documentation

Enumerator:
AttrProfileFlipMside 

profile flip mside

AttrBndSplineTangent 

bnd spline tangent

AttrBlankNormalDiffTaxis 

blank normal diff taxis

AttrBndHasSleepObj 

bnd has sleep obj

AttrClrnrNotParallelTaxis 

clrnr not parallel taxis

AttrBndNotParallelFloor 

bnd not parallel floor

AttrFloorNotUpToDate 

floor not up to date

AttrSingleProfileWithFirstCut 

single profile with first cut

AttrCutterConversionProblem 

cutter conversion problem

AttrPlmFeedcomp 

plm feedcomp

AttrPlmFillet 

plm fillet

AttrPlmSlowdown 

plm slowdown

AttrPlmGeometry 

plm geometry

AttrNcmObsoleteCustomFeed 

ncm obsolete custom feed

AttrNcmObsoleteLocalRetract 

ncm obsolete local retract

AttrNcmClearTraversalZero 

ncm clear traversal zero

AttrNcmObsoleteEngretToClearance 

ncm obsolete engret to clearance

AttrProbingInvalidNxVersion 

probing invalid nx version

AttrCustomDataGougingObsolete 

custom data gouging obsolete

AttrCustomDataGougingPartObsolete 

custom data gouging part obsolete

AttrCustomDataGougingDriveObsolete 

custom data gouging drive obsolete

AttrCustomDataIgnoreLoopsObsolete 

custom data ignore loops obsolete

The unit of feed rate.

Enumerator:
FeedRateUnitNone 

no feed rate unit

FeedRateUnitPerMinute 

use per minute as the feed rate unit

FeedRateUnitPerRevolution 

use per revolution as the feed rate unit

The status of the object.

Enumerator:
StatusComplete 

Object path has been output.

StatusRepost 

Object path must be post-processed.

StatusRegen 

Object path must be regenerated.


Member Function Documentation

Get the boolean value of the parameter index from the object.

Returns:
the boolean value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the feed rate value and unit of the parameter index from the object.

Returns:
the feed rate unit
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe feed rate value

Get the feed rate color of the parameter index from the object.

Returns:
the color number
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
std::vector<int> NXOpen::CAM::CAMObject::GetIntegerArrayValue ( const NXString title)

Get the integer array value of the parameter index from the object.

Returns:
the integer array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the integer value of the parameter index from the object.

Returns:
the integer value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the object value of the parameter index from the object.

Returns:
the object value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the object array value of the parameter index from the object.

Returns:
the object array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
std::vector<double> NXOpen::CAM::CAMObject::GetRealArrayValue ( const NXString title)

Get the real array value of the parameter index from the object.

Returns:
the real array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the real value of the parameter index from the object.

Returns:
the real value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the status of the input object.

Returns:
the object's status
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Reimplemented in NXOpen::CAM::FeatureGeometryGroup.

Get the string array value of the parameter index from the object.

Returns:
the string array
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.

Get the string value of the parameter index from the object.

Returns:
the string value
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
int NXOpen::CAM::CAMObject::GetWireEdmFeedRate ( const NXString title,
double *  value 
)

Get the feed rate value and side of the parameter index from the object, side is only used in wire edm.

Returns:
the feed rate side
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe feed rate value

Check if a 911 attribute exists in an object.

Returns:
true -- 911 attribute exists
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
attrIdthe attribute Id

Remove a specific 911 attribute from an object.


Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
attrIdthe attribute Id

Remove all 911 attributes from an object.


Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::CAMObject::SetBooleanValue ( const NXString title,
bool  value 
)

Set a boolean value to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe boolean value
void NXOpen::CAM::CAMObject::SetFeedRate ( const NXString title,
double  value,
NXOpen::CAM::CAMObject::FeedRateUnit  unit 
)

Set feed rate value and unit to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe feed rate value
unitthe feed rate unit
void NXOpen::CAM::CAMObject::SetFeedRateColor ( const NXString title,
int  value 
)

Set feed rate display color to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the paramter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe color number
void NXOpen::CAM::CAMObject::SetIntegerArrayValue ( const NXString title,
const std::vector< int > &  value 
)

Set integer array value to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe integer array
void NXOpen::CAM::CAMObject::SetIntegerValue ( const NXString title,
int  value 
)

Set an integer value to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe integer value
void NXOpen::CAM::CAMObject::SetObject ( const NXString title,
NXOpen::NXObject value 
)

Set a object to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe object
void NXOpen::CAM::CAMObject::SetObjectArrayValue ( const NXString title,
const std::vector< NXOpen::NXObject * > &  value 
)

Set object array to the parameter index for the object
Created in NX4.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe object array
void NXOpen::CAM::CAMObject::SetRealArrayValue ( const NXString title,
const std::vector< double > &  value 
)

Set real array to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe real array
void NXOpen::CAM::CAMObject::SetRealValue ( const NXString title,
double  value 
)

Set a real value to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe real value
void NXOpen::CAM::CAMObject::SetStringArrayValue ( const NXString title,
std::vector< NXString > &  value 
)

Set string array to the parameter index for the object
Created in NX4.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe string array
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAM::CAMObject::SetStringValue ( const NXString title,
const NXString value 
)

Set a string value to the parameter index for the object.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe string value
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAM::CAMObject::SetWireEdmFeedRate ( const NXString title,
double  value,
int  side 
)

Set feed rate value and side to the parameter index for the object, side is only used in wire edm.


Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
titlethe name of the parameter index
NOTE: The full Unicode character set is not supported for this parameter.
valuethe feed rate value
sideInside = 0, Outside = 1

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