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

This class is used for edit sinumerik collision avoidance properties. More...

Inheritance diagram for NXOpen::SIM::KinematicSinumerikCaBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PlcInitStateTypes { PlcInitStateTypesActive, PlcInitStateTypesInactive, PlcInitStateTypesPreselect }
 The init state types. More...
 
enum  PlcUsageTypes { PlcUsageTypesCollisionCheck, PlcUsageTypesVisualize, PlcUsageTypesAll }
 The usage types. More...
 

Public Member Functions

int DetailLevel ()
 Returns the detail level for this protection area
Created in NX9.0.0. More...
 
int MagazineIndex ()
 Returns the magazine index for this automatic protection area
Created in NX10.0.0. More...
 
int MagazineLocationIndex ()
 Returns the magazine location index for this automatic protection area
Created in NX10.0.0. More...
 
int PlcBit ()
 Returns the PLC bit for this protection area
Created in NX9.0.0. More...
 
NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes PlcInitState ()
 Returns the initial PLC state for this protection area
Created in NX9.0.0. More...
 
NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes PlcUsage ()
 Returns the PLC usage for this protection area
Created in NX9.0.0. More...
 
void SetDetailLevel (int level)
 Sets the detail level for this protection area
Created in NX9.0.0. More...
 
void SetMagazineIndex (int index)
 Sets the magazine index for this automatic protection area
Created in NX10.0.0. More...
 
void SetMagazineLocationIndex (int index)
 Sets the magazine location index for this automatic protection area
Created in NX10.0.0. More...
 
void SetPlcBit (int bit)
 Sets the PLC bit for this protection area
Created in NX9.0.0. More...
 
void SetPlcInitState (NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes state)
 Sets the initial PLC state for this protection area
Created in NX9.0.0. More...
 
void SetPlcUsage (NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes usage)
 Sets the PLC usage for this protection area
Created in NX9.0.0. More...
 
void SetTOIndex (int index)
 Sets the TO-index for this automatic protection area
Created in NX10.0.0. More...
 
int TOIndex ()
 Returns the TO-index for this automatic protection area
Created in NX10.0.0. 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

This class is used for edit sinumerik collision avoidance properties.

Calling Builder::Commit on this builder will only return NULL.
Use the KinematicConfigurator class to create a KinematicSinumerikCaBuilder object.

Created in NX9.0.0.

Member Enumeration Documentation

The init state types.

Enumerator
PlcInitStateTypesActive 

Active.

PlcInitStateTypesInactive 

Inactive.

PlcInitStateTypesPreselect 

Preselect.

The usage types.

Enumerator
PlcUsageTypesCollisionCheck 

Collision Check.

PlcUsageTypesVisualize 

Visualize.

PlcUsageTypesAll 

All.

Member Function Documentation

int NXOpen::SIM::KinematicSinumerikCaBuilder::DetailLevel ( )

Returns the detail level for this protection area
Created in NX9.0.0.



License requirements : None

int NXOpen::SIM::KinematicSinumerikCaBuilder::MagazineIndex ( )

Returns the magazine index for this automatic protection area
Created in NX10.0.0.



License requirements : None

int NXOpen::SIM::KinematicSinumerikCaBuilder::MagazineLocationIndex ( )

Returns the magazine location index for this automatic protection area
Created in NX10.0.0.



License requirements : None

int NXOpen::SIM::KinematicSinumerikCaBuilder::PlcBit ( )

Returns the PLC bit for this protection area
Created in NX9.0.0.



License requirements : None

NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitState ( )

Returns the initial PLC state for this protection area
Created in NX9.0.0.



License requirements : None

NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsage ( )

Returns the PLC usage for this protection area
Created in NX9.0.0.



License requirements : None

void NXOpen::SIM::KinematicSinumerikCaBuilder::SetDetailLevel ( int  level)

Sets the detail level for this protection area
Created in NX9.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
levelthe detail value value 0-3
void NXOpen::SIM::KinematicSinumerikCaBuilder::SetMagazineIndex ( int  index)

Sets the magazine index for this automatic protection area
Created in NX10.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
indexthe magazine index
void NXOpen::SIM::KinematicSinumerikCaBuilder::SetMagazineLocationIndex ( int  index)

Sets the magazine location index for this automatic protection area
Created in NX10.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
indexthe magazine location index
void NXOpen::SIM::KinematicSinumerikCaBuilder::SetPlcBit ( int  bit)

Sets the PLC bit for this protection area
Created in NX9.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
bitthe plc bit value 0-63
void NXOpen::SIM::KinematicSinumerikCaBuilder::SetPlcInitState ( NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes  state)

Sets the initial PLC state for this protection area
Created in NX9.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
statethe init state
void NXOpen::SIM::KinematicSinumerikCaBuilder::SetPlcUsage ( NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes  usage)

Sets the PLC usage for this protection area
Created in NX9.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
usagethe usage
void NXOpen::SIM::KinematicSinumerikCaBuilder::SetTOIndex ( int  index)

Sets the TO-index for this automatic protection area
Created in NX10.0.0.



License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters
indexthe TO number
int NXOpen::SIM::KinematicSinumerikCaBuilder::TOIndex ( )

Returns the TO-index for this automatic protection area
Created in NX10.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.