Represents a NXOpen::Mechatronics::CamProfile builder. More...

Inheritance diagram for NXOpen::Mechatronics::CamProfileBuilder:

Classes
struct	Element
	Contains segment information of a motion segment. More...

Public Types
enum	MasterValueUnit { MasterValueUnitLinear, MasterValueUnitRotary, MasterValueUnitTime }
	The master value unit indicates which type master joint is. More...

enum	ProfileCyclicType { ProfileCyclicTypeRelativeCyclic, ProfileCyclicTypeCyclic, ProfileCyclicTypeNonCyclic }
	Indicates which cyclic type should be take.The type of Cam Profile can be switched between non-cyclic, cyclic and relative cyclic. More...

enum	SlaveValueUnit { SlaveValueUnitLinearPosition, SlaveValueUnitRotaryPosition, SlaveValueUnitLinearSpeed, SlaveValueUnitRotarySpeed }
	The master value unit indicates which type master joint is. More...

Public Member Functions
void	AddElement (NXOpen::NXObject *part, const NXOpen::Mechatronics::CamProfileBuilder::Element &element)
	Add element to builder. More...

NXOpen::Mechatronics::CamProfileBuilder::Element	AskElementByIndex (int index)
	Ask segment element. More...

int	AskElementsLength ()
	Ask segments length. More...

bool	CheckingG2Continuity ()
	Returns the indicator that a cam profile should check G2 continuous or not Created in NX10.0.0. More...

void	ClearElements ()
	Clear elements . More...

NXOpen::Mechatronics::CamProfileBuilder::ProfileCyclicType	CyclicType ()
	Returns the cyclic type of a cam profile Created in NX9.0.0. More...

void	EditElement (int index, NXOpen::NXObject *part, const NXOpen::Mechatronics::CamProfileBuilder::Element &element)
	Edit the specific element of builder. More...

int	FindElementIndex (const NXOpen::Mechatronics::CamProfileBuilder::Element &element)
	Find the element index. More...

bool	IsForElecCam ()
	Returns the indicator that a cam profile is designed for a electronic cam More...

NXOpen::Expression *	MasterMaximum ()
	Returns the maximum master value Created in NX9.0.0. More...

NXOpen::Expression *	MasterMinimum ()
	Returns the minimum master value Created in NX9.0.0. More...

NXOpen::Mechatronics::CamProfileBuilder::MasterValueUnit	MasterUnit ()
	Returns the type of master joint Created in NX9.0.0. More...

NXString	Name ()
	Returns the cam profile name Created in NX9.0.0. More...

void	RemoveElementByIndex (int index)
	Remove element by index. More...

void	SetCheckingG2Continuity (bool checking)
	Sets the indicator that a cam profile should check G2 continuous or not Created in NX10.0.0. More...

void	SetCyclicType (NXOpen::Mechatronics::CamProfileBuilder::ProfileCyclicType cyclicType)
	Sets the cyclic type of a cam profile Created in NX9.0.0. More...

void	SetForElecCam (bool isForElecCam)
	Sets the indicator that a cam profile is designed for a electronic cam More...

void	SetMasterUnit (NXOpen::Mechatronics::CamProfileBuilder::MasterValueUnit masterUnit)
	Sets the type of master joint Created in NX9.0.0. More...

void	SetName (const NXString &name)
	Sets the cam profile name Created in NX9.0.0. More...

void	SetName (const char *name)
	Sets the cam profile name Created in NX9.0.0. More...

void	SetSegmentTable (NXOpen::Mechatronics::CamProfile *segmentTableObject)
	Set segment table. More...

void	SetSlaveUnit (NXOpen::Mechatronics::CamProfileBuilder::SlaveValueUnit slaveUnit)
	Sets the type of slave joint or slave controller Created in NX9.0.0. More...

NXOpen::Expression *	SlaveMaximum ()
	Returns the maximum slave value. More...

NXOpen::Expression *	SlaveMinimum ()
	Returns the minimum slave Created in NX9.0.0. More...

NXOpen::Mechatronics::CamProfileBuilder::SlaveValueUnit	SlaveUnit ()
	Returns the type of slave joint or slave controller Created in NX9.0.0. More...

void	SwitchSegmentTable (NXOpen::Mechatronics::CamProfile *segmentTableObject)
	Switch segments table object. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 NXOpen::Mechatronics::CamProfile builder.

To create a new instance of this class, use NXOpen::Mechatronics::CamProfileCollection::CreateCamProfileBuilder

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::CamProfileBuilder::MasterValueUnit

The master value unit indicates which type master joint is.

Enumerator
MasterValueUnitLinear	Linear.
MasterValueUnitRotary	Rotary.
MasterValueUnitTime	Time.

enum NXOpen::Mechatronics::CamProfileBuilder::ProfileCyclicType

Indicates which cyclic type should be take.The type of Cam Profile can be switched between non-cyclic, cyclic and relative cyclic.

Enumerator

ProfileCyclicTypeRelativeCyclic

In Relative Cyclic Cam Profiles the start point and end point of the profile do not necessarily have to be equal.

ProfileCyclicTypeCyclic

In Cyclic Cam Profiles the points at the beginning and the end of the Master Axis range need to be identical with respect to Slave Axis value, slope and curve.

ProfileCyclicTypeNonCyclic

Non-cyclic Cam Profiles are defined only in the defined master axis range.

Exceeding this range will cause an error.

enum NXOpen::Mechatronics::CamProfileBuilder::SlaveValueUnit

The master value unit indicates which type master joint is.

Enumerator
SlaveValueUnitLinearPosition	Linear Position.
SlaveValueUnitRotaryPosition	Rotary Position.
SlaveValueUnitLinearSpeed	Linear Speed.
SlaveValueUnitRotarySpeed	Rotary Speed.

Member Function Documentation

void NXOpen::Mechatronics::CamProfileBuilder::AddElement	(	NXOpen::NXObject *	part,
		const NXOpen::Mechatronics::CamProfileBuilder::Element &	element
	)

Add element to builder.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

part	part
element	element

NXOpen::Mechatronics::CamProfileBuilder::Element NXOpen::Mechatronics::CamProfileBuilder::AskElementByIndex ( int index )

Ask segment element.

Returns: Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

index index

int NXOpen::Mechatronics::CamProfileBuilder::AskElementsLength ( )

Ask segments length.

Returns: Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::CamProfileBuilder::CheckingG2Continuity ( )

Returns the indicator that a cam profile should check G2 continuous or not
Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::CamProfileBuilder::ClearElements ( )

Clear elements .

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::CamProfileBuilder::ProfileCyclicType NXOpen::Mechatronics::CamProfileBuilder::CyclicType ( )

Returns the cyclic type of a cam profile
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::CamProfileBuilder::EditElement	(	int	index,
		NXOpen::NXObject *	part,
		const NXOpen::Mechatronics::CamProfileBuilder::Element &	element
	)

Edit the specific element of builder.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

index	The element index
part	part
element	element

int NXOpen::Mechatronics::CamProfileBuilder::FindElementIndex ( const NXOpen::Mechatronics::CamProfileBuilder::Element & element )

Find the element index.

Returns: Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

element element

bool NXOpen::Mechatronics::CamProfileBuilder::IsForElecCam ( )

Returns the indicator that a cam profile is designed for a electronic cam

Deprecated:: Deprecated in NX10.0.0.

Set the boolean using Mechatronics::CamProfileBuilder::CheckingG2Continuity to query or edit it.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::CamProfileBuilder::MasterMaximum ( )

Returns the maximum master value
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::CamProfileBuilder::MasterMinimum ( )

Returns the minimum master value
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::CamProfileBuilder::MasterValueUnit NXOpen::Mechatronics::CamProfileBuilder::MasterUnit ( )

Returns the type of master joint
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::CamProfileBuilder::Name ( )

Returns the cam profile name
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::CamProfileBuilder::RemoveElementByIndex ( int index )

Remove element by index.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

index index

void NXOpen::Mechatronics::CamProfileBuilder::SetCheckingG2Continuity ( bool checking )

Sets the indicator that a cam profile should check G2 continuous or not
Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

checking checking

void NXOpen::Mechatronics::CamProfileBuilder::SetCyclicType ( NXOpen::Mechatronics::CamProfileBuilder::ProfileCyclicType cyclicType )

Sets the cyclic type of a cam profile
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

cyclicType cyclictype

void NXOpen::Mechatronics::CamProfileBuilder::SetForElecCam ( bool isForElecCam )

Sets the indicator that a cam profile is designed for a electronic cam

Deprecated:: Deprecated in NX10.0.0.

Set the boolean using Mechatronics::CamProfileBuilder::SetCheckingG2Continuity to query or edit it.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isForElecCam isforeleccam

void NXOpen::Mechatronics::CamProfileBuilder::SetMasterUnit ( NXOpen::Mechatronics::CamProfileBuilder::MasterValueUnit masterUnit )

Sets the type of master joint
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

masterUnit masterunit

void NXOpen::Mechatronics::CamProfileBuilder::SetName ( const NXString & name )

Sets the cam profile name
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::CamProfileBuilder::SetName ( const char * name )

Sets the cam profile name
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::CamProfileBuilder::SetSegmentTable ( NXOpen::Mechatronics::CamProfile * segmentTableObject )

Set segment table.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

segmentTableObject segmenttableobject

void NXOpen::Mechatronics::CamProfileBuilder::SetSlaveUnit ( NXOpen::Mechatronics::CamProfileBuilder::SlaveValueUnit slaveUnit )

Sets the type of slave joint or slave controller
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

slaveUnit slaveunit

NXOpen::Expression* NXOpen::Mechatronics::CamProfileBuilder::SlaveMaximum ( )

Returns the maximum slave value.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::CamProfileBuilder::SlaveMinimum ( )

Returns the minimum slave
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::CamProfileBuilder::SlaveValueUnit NXOpen::Mechatronics::CamProfileBuilder::SlaveUnit ( )

Returns the type of slave joint or slave controller
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::CamProfileBuilder::SwitchSegmentTable ( NXOpen::Mechatronics::CamProfile * segmentTableObject )

Switch segments table object.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

segmentTableObject segmenttableobject

The documentation for this class was generated from the following file:

Mechatronics_CamProfileBuilder.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation