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

Inheritance diagram for NXOpen::Mechatronics::ParameterStockBuilder:

Public Types
enum	Assignment { AssignmentNone, AssignmentByOrder, AssignmentRandom }
	the assignment for runtime property. More...

enum	DataType { DataTypeBool, DataTypeInt, DataTypeReal, DataTypeString, DataTypeList }
	the data type for parameter value. More...

Public Member Functions
void	AddBoolParameter (const NXString &name, bool value, bool predefined, bool readOnly)
	Adds Bool parameter. More...

void	AddBoolParameter (const char *name, bool value, bool predefined, bool readOnly)
	Adds Bool parameter. More...

void	AddIntParameter (const NXString &name, int value, bool predefined, bool readOnly)
	Adds Int parameter. More...

void	AddIntParameter (const char *name, int value, bool predefined, bool readOnly)
	Adds Int parameter. More...

void	AddListParameter (const NXString &name, std::vector< NXString > &values, NXOpen::Mechatronics::ParameterStockBuilder::Assignment eAssignment, bool predefined, bool readOnly)
	Adds List parameter. More...

void	AddListParameter (const char *name, std::vector< NXString > &values, NXOpen::Mechatronics::ParameterStockBuilder::Assignment eAssignment, bool predefined, bool readOnly)
	Adds List parameter. More...

void	AddRealParameter (const NXString &name, double value, NXOpen::Unit *unit, bool predefined, bool readOnly)
	Adds Real parameter. More...

void	AddRealParameter (const char name, double value, NXOpen::Unit unit, bool predefined, bool readOnly)
	Adds Real parameter. More...

void	AddStringParameter (const NXString &name, const NXString &value, bool predefined, bool readOnly)
	Adds String parameter. More...

void	AddStringParameter (const char name, const char value, bool predefined, bool readOnly)
	Adds String parameter. More...

NXString	ApplicationName ()
	Returns the application name. More...

void	DeleteParameter (const NXString &name)
	Delete parameter. More...

void	DeleteParameter (const char *name)
	Delete parameter. More...

void	EditBoolParameter (const NXString &name, bool value)
	Edits bool parameter value. More...

void	EditBoolParameter (const char *name, bool value)
	Edits bool parameter value. More...

void	EditIntParameter (const NXString &name, int value)
	Edits Int parameter. More...

void	EditIntParameter (const char *name, int value)
	Edits Int parameter. More...

void	EditListParameter (const NXString &name, std::vector< NXString > &values, NXOpen::Mechatronics::ParameterStockBuilder::Assignment eAssignment)
	Edits List parameter. More...

void	EditListParameter (const char *name, std::vector< NXString > &values, NXOpen::Mechatronics::ParameterStockBuilder::Assignment eAssignment)
	Edits List parameter. More...

void	EditRealParameter (const NXString &name, double value, NXOpen::Unit *unit)
	Edits Real parameter. More...

void	EditRealParameter (const char name, double value, NXOpen::Unit unit)
	Edits Real parameter. More...

void	EditStringParameter (const NXString &name, const NXString &value)
	Edits String parameter. More...

void	EditStringParameter (const char name, const char value)
	Edits String parameter. More...

bool	GetBoolParameter (const NXString &name, bool predefined, bool readOnly)
	Gets bool parameter value. More...

bool	GetBoolParameter (const char name, bool predefined, bool *readOnly)
	Gets bool parameter value. More...

int	GetIntParameter (const NXString &name, bool predefined, bool readOnly)
	Gets int parameter value. More...

int	GetIntParameter (const char name, bool predefined, bool *readOnly)
	Gets int parameter value. More...

std::vector< NXString >	GetListParameter (const NXString &name, NXOpen::Mechatronics::ParameterStockBuilder::Assignment eAssignment, bool predefined, bool *readOnly)
	Gets list parameter value. More...

std::vector< NXString >	GetListParameter (const char name, NXOpen::Mechatronics::ParameterStockBuilder::Assignment eAssignment, bool predefined, bool readOnly)
	Gets list parameter value. More...

std::vector< NXString >	GetParameterNamesAndTypes (std::vector< NXOpen::Mechatronics::ParameterStockBuilder::DataType > &types)
	Gets parameter names and types. More...

double	GetRealParameter (const NXString &name, NXOpen::Unit *unit, bool predefined, bool *readOnly)
	Gets real parameter value. More...

double	GetRealParameter (const char name, NXOpen::Unit unit, bool predefined, bool *readOnly)
	Gets real parameter value. More...

NXString	GetStringParameter (const NXString &name, bool predefined, bool readOnly)
	Gets string parameter value. More...

NXString	GetStringParameter (const char name, bool predefined, bool *readOnly)
	Gets string parameter value. More...

void	SetApplicationName (const NXString &applicationName)
	Sets the application name. More...

void	SetApplicationName (const char *applicationName)
	Sets the application name. 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::ParameterStockBuilder builder.

This class is sub-object of another builder, and cannot be directly instantiated.

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::ParameterStockBuilder::Assignment

the assignment for runtime property.

Enumerator
AssignmentNone	None.
AssignmentByOrder	By order.
AssignmentRandom	Random.

enum NXOpen::Mechatronics::ParameterStockBuilder::DataType

the data type for parameter value.

Enumerator
DataTypeBool	Bool.
DataTypeInt	Int.
DataTypeReal	Real.
DataTypeString	String.
DataTypeList	Enumeration.

Member Function Documentation

void NXOpen::Mechatronics::ParameterStockBuilder::AddBoolParameter	(	const NXString &	name,
		bool	value,
		bool	predefined,
		bool	readOnly
	)

Adds Bool parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddBoolParameter	(	const char *	name,
		bool	value,
		bool	predefined,
		bool	readOnly
	)

Adds Bool parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddIntParameter	(	const NXString &	name,
		int	value,
		bool	predefined,
		bool	readOnly
	)

Adds Int parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddIntParameter	(	const char *	name,
		int	value,
		bool	predefined,
		bool	readOnly
	)

Adds Int parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddListParameter	(	const NXString &	name,
		std::vector< NXString > &	values,
		NXOpen::Mechatronics::ParameterStockBuilder::Assignment	eAssignment,
		bool	predefined,
		bool	readOnly
	)

Adds List parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
values	values
eAssignment	eassignment
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddListParameter	(	const char *	name,
		std::vector< NXString > &	values,
		NXOpen::Mechatronics::ParameterStockBuilder::Assignment	eAssignment,
		bool	predefined,
		bool	readOnly
	)

Adds List parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
values	values
eAssignment	eassignment
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddRealParameter	(	const NXString &	name,
		double	value,
		NXOpen::Unit *	unit,
		bool	predefined,
		bool	readOnly
	)

Adds Real parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
unit	unit
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddRealParameter	(	const char *	name,
		double	value,
		NXOpen::Unit *	unit,
		bool	predefined,
		bool	readOnly
	)

Adds Real parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
unit	unit
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddStringParameter	(	const NXString &	name,
		const NXString &	value,
		bool	predefined,
		bool	readOnly
	)

Adds String parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::AddStringParameter	(	const char *	name,
		const char *	value,
		bool	predefined,
		bool	readOnly
	)

Adds String parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
predefined	predefined
readOnly	read only

NXString NXOpen::Mechatronics::ParameterStockBuilder::ApplicationName ( )

Returns the application name.

Created in NX10.0.0.

License requirements : None

void NXOpen::Mechatronics::ParameterStockBuilder::DeleteParameter ( const NXString & name )

Delete parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::ParameterStockBuilder::DeleteParameter ( const char * name )

Delete parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::ParameterStockBuilder::EditBoolParameter	(	const NXString &	name,
		bool	value
	)

Edits bool parameter value.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value

void NXOpen::Mechatronics::ParameterStockBuilder::EditBoolParameter	(	const char *	name,
		bool	value
	)

Edits bool parameter value.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value

void NXOpen::Mechatronics::ParameterStockBuilder::EditIntParameter	(	const NXString &	name,
		int	value
	)

Edits Int parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value

void NXOpen::Mechatronics::ParameterStockBuilder::EditIntParameter	(	const char *	name,
		int	value
	)

Edits Int parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value

void NXOpen::Mechatronics::ParameterStockBuilder::EditListParameter	(	const NXString &	name,
		std::vector< NXString > &	values,
		NXOpen::Mechatronics::ParameterStockBuilder::Assignment	eAssignment
	)

Edits List parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
values	values
eAssignment	eassignment

void NXOpen::Mechatronics::ParameterStockBuilder::EditListParameter	(	const char *	name,
		std::vector< NXString > &	values,
		NXOpen::Mechatronics::ParameterStockBuilder::Assignment	eAssignment
	)

Edits List parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
values	values
eAssignment	eassignment

void NXOpen::Mechatronics::ParameterStockBuilder::EditRealParameter	(	const NXString &	name,
		double	value,
		NXOpen::Unit *	unit
	)

Edits Real parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
unit	unit

void NXOpen::Mechatronics::ParameterStockBuilder::EditRealParameter	(	const char *	name,
		double	value,
		NXOpen::Unit *	unit
	)

Edits Real parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value
unit	unit

void NXOpen::Mechatronics::ParameterStockBuilder::EditStringParameter	(	const NXString &	name,
		const NXString &	value
	)

Edits String parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value

void NXOpen::Mechatronics::ParameterStockBuilder::EditStringParameter	(	const char *	name,
		const char *	value
	)

Edits String parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name	name
value	value

bool NXOpen::Mechatronics::ParameterStockBuilder::GetBoolParameter	(	const NXString &	name,
		bool *	predefined,
		bool *	readOnly
	)

Gets bool parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
predefined	predefined
readOnly	read only

bool NXOpen::Mechatronics::ParameterStockBuilder::GetBoolParameter	(	const char *	name,
		bool *	predefined,
		bool *	readOnly
	)

Gets bool parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
predefined	predefined
readOnly	read only

int NXOpen::Mechatronics::ParameterStockBuilder::GetIntParameter	(	const NXString &	name,
		bool *	predefined,
		bool *	readOnly
	)

Gets int parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
predefined	predefined
readOnly	read only

int NXOpen::Mechatronics::ParameterStockBuilder::GetIntParameter	(	const char *	name,
		bool *	predefined,
		bool *	readOnly
	)

Gets int parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
predefined	predefined
readOnly	read only

std::vector<NXString> NXOpen::Mechatronics::ParameterStockBuilder::GetListParameter	(	const NXString &	name,
		NXOpen::Mechatronics::ParameterStockBuilder::Assignment *	eAssignment,
		bool *	predefined,
		bool *	readOnly
	)

Gets list parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
eAssignment	eassignment
predefined	predefined
readOnly	read only

std::vector<NXString> NXOpen::Mechatronics::ParameterStockBuilder::GetListParameter	(	const char *	name,
		NXOpen::Mechatronics::ParameterStockBuilder::Assignment *	eAssignment,
		bool *	predefined,
		bool *	readOnly
	)

Gets list parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
eAssignment	eassignment
predefined	predefined
readOnly	read only

std::vector<NXString> NXOpen::Mechatronics::ParameterStockBuilder::GetParameterNamesAndTypes ( std::vector< NXOpen::Mechatronics::ParameterStockBuilder::DataType > & types )

Gets parameter names and types.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

types types

double NXOpen::Mechatronics::ParameterStockBuilder::GetRealParameter	(	const NXString &	name,
		NXOpen::Unit **	unit,
		bool *	predefined,
		bool *	readOnly
	)

Gets real parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
unit	unit
predefined	predefined
readOnly	read only

double NXOpen::Mechatronics::ParameterStockBuilder::GetRealParameter	(	const char *	name,
		NXOpen::Unit **	unit,
		bool *	predefined,
		bool *	readOnly
	)

Gets real parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
unit	unit
predefined	predefined
readOnly	read only

NXString NXOpen::Mechatronics::ParameterStockBuilder::GetStringParameter	(	const NXString &	name,
		bool *	predefined,
		bool *	readOnly
	)

Gets string parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
predefined	predefined
readOnly	read only

NXString NXOpen::Mechatronics::ParameterStockBuilder::GetStringParameter	(	const char *	name,
		bool *	predefined,
		bool *	readOnly
	)

Gets string parameter value.

Returns: Created in NX10.0.0.

License requirements : None

Parameters

name	name
predefined	predefined
readOnly	read only

void NXOpen::Mechatronics::ParameterStockBuilder::SetApplicationName ( const NXString & applicationName )

Sets the application name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

applicationName applicationname

void NXOpen::Mechatronics::ParameterStockBuilder::SetApplicationName ( const char * applicationName )

Sets the application name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

applicationName applicationname

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

Mechatronics_ParameterStockBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation