NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Mechatronics::TagTableBuilder Class Reference

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

Inheritance diagram for NXOpen::Mechatronics::TagTableBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void ChangeId (const NXString &oldId, const NXString &newId)
 Changes ID. More...
 
void ChangeId (const char *oldId, const char *newId)
 Changes ID. More...
 
void DeleteAllParameters ()
 Delete all parameters. More...
 
void DeleteParameter (const NXString &id)
 Delete parameter. More...
 
void DeleteParameter (const char *id)
 Delete parameter. More...
 
void EditBoolParameter (const NXString &id, const NXString &name, bool value)
 Edits bool parameter value. More...
 
void EditBoolParameter (const char *id, const char *name, bool value)
 Edits bool parameter value. More...
 
void EditIntParameter (const NXString &id, const NXString &name, int value)
 Edits Int parameter. More...
 
void EditIntParameter (const char *id, const char *name, int value)
 Edits Int parameter. More...
 
void EditListParameter (const NXString &id, const NXString &name, int newSelectedIndex)
 Edits List parameter. More...
 
void EditListParameter (const char *id, const char *name, int newSelectedIndex)
 Edits List parameter. More...
 
void EditRealParameter (const NXString &id, const NXString &name, double value)
 Edits Real parameter. More...
 
void EditRealParameter (const char *id, const char *name, double value)
 Edits Real parameter. More...
 
void EditStringParameter (const NXString &id, const NXString &name, const NXString &value)
 Edits String parameter. More...
 
void EditStringParameter (const char *id, const char *name, const char *value)
 Edits String parameter. More...
 
NXString GenerateNewValue ()
 Generates new value. More...
 
bool GetBoolParameter (const NXString &id, const NXString &name)
 Gets bool parameter value. More...
 
bool GetBoolParameter (const char *id, const char *name)
 Gets bool parameter value. More...
 
NXOpen::Mechatronics::TagFormObjectGetform ()
 Gets selected form NXOpen::Mechatronics::TagFormObject . More...
 
std::vector< NXStringGetIds ()
 Gets Ids of all values . More...
 
int GetIntParameter (const NXString &id, const NXString &name)
 Gets int parameter value. More...
 
int GetIntParameter (const char *id, const char *name)
 Gets int parameter value. More...
 
std::vector< NXStringGetListParameter (const NXString &id, const NXString &name, int *selectedIndex)
 Gets list parameter value. More...
 
std::vector< NXStringGetListParameter (const char *id, const char *name, int *selectedIndex)
 Gets list parameter value. More...
 
std::vector< NXStringGetParameterNamesAndTypesByID (const NXString &id, std::vector< NXOpen::Mechatronics::ParameterStockBuilder::DataType > &types)
 Gets parameter names and types by value ID. More...
 
std::vector< NXStringGetParameterNamesAndTypesByID (const char *id, std::vector< NXOpen::Mechatronics::ParameterStockBuilder::DataType > &types)
 Gets parameter names and types by value ID. More...
 
double GetRealParameter (const NXString &id, const NXString &name, NXOpen::Unit **unit)
 Gets real parameter value. More...
 
double GetRealParameter (const char *id, const char *name, NXOpen::Unit **unit)
 Gets real parameter value. More...
 
NXString GetStringParameter (const NXString &id, const NXString &name)
 Gets string parameter value. More...
 
NXString GetStringParameter (const char *id, const char *name)
 Gets string parameter value. More...
 
void MoveParameterDown (const NXString &id)
 Move parameter down. More...
 
void MoveParameterDown (const char *id)
 Move parameter down. More...
 
void MoveParameterUp (const NXString &id)
 Move parameter up. More...
 
void MoveParameterUp (const char *id)
 Move parameter up. More...
 
NXString Name ()
 Returns the name. More...
 
void SetForm (NXOpen::Mechatronics::TagFormObject *form)
 Sets the form NXOpen::Mechatronics::TagFormObject object. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. 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 NXOpen::Mechatronics::TagTableBuilder builder.


To create a new instance of this class, use NXOpen::Mechatronics::TagTableCollection::CreateTagTableBuilder

Created in NX10.0.0.

Member Function Documentation

void NXOpen::Mechatronics::TagTableBuilder::ChangeId ( const NXString oldId,
const NXString newId 
)

Changes ID.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
oldIdoldid
newIdnewid
void NXOpen::Mechatronics::TagTableBuilder::ChangeId ( const char *  oldId,
const char *  newId 
)

Changes ID.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
oldIdoldid
newIdnewid
void NXOpen::Mechatronics::TagTableBuilder::DeleteAllParameters ( )

Delete all parameters.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::TagTableBuilder::DeleteParameter ( const NXString id)

Delete parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
void NXOpen::Mechatronics::TagTableBuilder::DeleteParameter ( const char *  id)

Delete parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
void NXOpen::Mechatronics::TagTableBuilder::EditBoolParameter ( const NXString id,
const NXString name,
bool  value 
)

Edits bool parameter value.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditBoolParameter ( const char *  id,
const char *  name,
bool  value 
)

Edits bool parameter value.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditIntParameter ( const NXString id,
const NXString name,
int  value 
)

Edits Int parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditIntParameter ( const char *  id,
const char *  name,
int  value 
)

Edits Int parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditListParameter ( const NXString id,
const NXString name,
int  newSelectedIndex 
)

Edits List parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
newSelectedIndexnewselectedindex
void NXOpen::Mechatronics::TagTableBuilder::EditListParameter ( const char *  id,
const char *  name,
int  newSelectedIndex 
)

Edits List parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
newSelectedIndexnewselectedindex
void NXOpen::Mechatronics::TagTableBuilder::EditRealParameter ( const NXString id,
const NXString name,
double  value 
)

Edits Real parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditRealParameter ( const char *  id,
const char *  name,
double  value 
)

Edits Real parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditStringParameter ( const NXString id,
const NXString name,
const NXString value 
)

Edits String parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
void NXOpen::Mechatronics::TagTableBuilder::EditStringParameter ( const char *  id,
const char *  name,
const char *  value 
)

Edits String parameter.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
namename
valuevalue
NXString NXOpen::Mechatronics::TagTableBuilder::GenerateNewValue ( )

Generates new value.

Returns

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
bool NXOpen::Mechatronics::TagTableBuilder::GetBoolParameter ( const NXString id,
const NXString name 
)

Gets bool parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
bool NXOpen::Mechatronics::TagTableBuilder::GetBoolParameter ( const char *  id,
const char *  name 
)

Gets bool parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
NXOpen::Mechatronics::TagFormObject* NXOpen::Mechatronics::TagTableBuilder::Getform ( )

Gets selected form NXOpen::Mechatronics::TagFormObject .

Returns

Created in NX10.0.0.

License requirements : None
std::vector<NXString> NXOpen::Mechatronics::TagTableBuilder::GetIds ( )

Gets Ids of all values .

Returns

Created in NX10.0.0.

License requirements : None
int NXOpen::Mechatronics::TagTableBuilder::GetIntParameter ( const NXString id,
const NXString name 
)

Gets int parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
int NXOpen::Mechatronics::TagTableBuilder::GetIntParameter ( const char *  id,
const char *  name 
)

Gets int parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
std::vector<NXString> NXOpen::Mechatronics::TagTableBuilder::GetListParameter ( const NXString id,
const NXString name,
int *  selectedIndex 
)

Gets list parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
selectedIndexselectedindex
std::vector<NXString> NXOpen::Mechatronics::TagTableBuilder::GetListParameter ( const char *  id,
const char *  name,
int *  selectedIndex 
)

Gets list parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
selectedIndexselectedindex
std::vector<NXString> NXOpen::Mechatronics::TagTableBuilder::GetParameterNamesAndTypesByID ( const NXString id,
std::vector< NXOpen::Mechatronics::ParameterStockBuilder::DataType > &  types 
)

Gets parameter names and types by value ID.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
typestypes
std::vector<NXString> NXOpen::Mechatronics::TagTableBuilder::GetParameterNamesAndTypesByID ( const char *  id,
std::vector< NXOpen::Mechatronics::ParameterStockBuilder::DataType > &  types 
)

Gets parameter names and types by value ID.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
typestypes
double NXOpen::Mechatronics::TagTableBuilder::GetRealParameter ( const NXString id,
const NXString name,
NXOpen::Unit **  unit 
)

Gets real parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
unitunit
double NXOpen::Mechatronics::TagTableBuilder::GetRealParameter ( const char *  id,
const char *  name,
NXOpen::Unit **  unit 
)

Gets real parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
unitunit
NXString NXOpen::Mechatronics::TagTableBuilder::GetStringParameter ( const NXString id,
const NXString name 
)

Gets string parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
NXString NXOpen::Mechatronics::TagTableBuilder::GetStringParameter ( const char *  id,
const char *  name 
)

Gets string parameter value.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
idid
namename
void NXOpen::Mechatronics::TagTableBuilder::MoveParameterDown ( const NXString id)

Move parameter down.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
void NXOpen::Mechatronics::TagTableBuilder::MoveParameterDown ( const char *  id)

Move parameter down.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
void NXOpen::Mechatronics::TagTableBuilder::MoveParameterUp ( const NXString id)

Move parameter up.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
void NXOpen::Mechatronics::TagTableBuilder::MoveParameterUp ( const char *  id)

Move parameter up.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
idid
NXString NXOpen::Mechatronics::TagTableBuilder::Name ( )

Returns the name.


Created in NX10.0.0.

License requirements : None

void NXOpen::Mechatronics::TagTableBuilder::SetForm ( NXOpen::Mechatronics::TagFormObject form)

Sets the form NXOpen::Mechatronics::TagFormObject object.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
formform
void NXOpen::Mechatronics::TagTableBuilder::SetName ( const NXString name)

Sets the name.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::TagTableBuilder::SetName ( const char *  name)

Sets the name.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename

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