|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
Represents Parameter
Created in NX1847.0.0.
More...
Public Member Functions | |
| NXOpen::ParamLibParameter * | Copy (NXOpen::NXObject *partObject) |
| Creates new (copied) parameter with same properties as the original parameter. More... | |
| NXOpen::ParamLibParameter * | CopyLibParamToPart (NXOpen::NXObject *partObject) |
| Copies a library parameter to a part. More... | |
| NXOpen::ParamLibParameter * | CopyLibParamToPart (NXOpen::NXObject *partObject, bool editable) |
| Copies a library parameter to a part. More... | |
| void | Delete () |
| Deletes a parameter from the part. More... | |
| void | DeleteOrphanedUserParameterModels () |
| Deletes Orphaned User Parameter (UPARAM) Models and Properties from a parameter. More... | |
| void | DeleteUserParameterModels () |
| Deletes User Parameter (UPARAM) Model Property Values from a parameter. More... | |
| NXString | GetAlternatename () |
| Returns the parameter alternate name. More... | |
| NXString | GetCategory () |
| Returns the parameter category. More... | |
| NXString | GetDescription () |
| Returns the parameter description. More... | |
| int | GetId () |
| Returns the parameter id. More... | |
| NXString | GetLibraryName () |
| Returns the library name if the parameter was loaded from a library. More... | |
| NXString | GetLibraryType () |
| Returns the parameter library type this parameter belogns to. More... | |
| NXString | GetParameterCategory () |
| Returns the parameter category using international character set. More... | |
| bool | GetParameterEditable () |
| Returns whether the parameter can be modified or not. More... | |
| int | GetParameterType () |
| Returns the parameter type. More... | |
| void | GetParentlibraryparameter (NXString *parentName, NXString *parentLibraryName) |
| Returns the parent libary parameter information. More... | |
| NXOpen::ParamLibParameter * | GetParentparameter () |
| Returns the parent parameter that the parameter was copied from. More... | |
| NXOpen::BasePropertyTable * | GetPropTable () |
| Returns the property table that contains the properties for this parameter. More... | |
| NXString | GetSubcategory () |
| Returns the parameter sub-category. More... | |
| NXString | GetTeamcenterParameterItem () |
| Returns the Teamcenter item if the parameter was loaded from Teamcenter. More... | |
| void | GetUsage (std::vector< NXOpen::NXObject * > &objects) |
| Finds the objects using this parameter. More... | |
| NXString | GetVersion () |
| Returns the parameter version . More... | |
| bool | HasParentlibraryparameter () |
| Returns whether the parameter was copied from a library parameter. More... | |
| bool | HasParentparameter () |
| Returns whether the parameter was copied from another parameter. More... | |
| void | InfoParameter () |
| Displays the property values for the parameter in the information window. More... | |
| void | InfoParameterToFile (bool bOverride, const NXString &pcFileName) |
| Writes the property values for the parameter to a file. More... | |
| void | InfoParameterToFile (bool bOverride, const char *pcFileName) |
| Writes the property values for the parameter to a file. More... | |
| bool | IsLoadedLibraryParameter () |
| Returns true if the parameter is loaded from a library (not Teamcenter). More... | |
| bool | IsLoadedTeamcenterParameterItem () |
| Returns true if the parameter is loaded from Teamcenter. More... | |
| bool | IsNonlibraryParameter () |
| Returns true if the parameter is locally defined (not a library/Teamcenter parameter). More... | |
| void | ResyncWithLibraryDefinition () |
| Re-synchronizes a loaded library parameter to match its latest library definition. More... | |
| void | SetAlternatename (const NXString ¶meterAlternatename) |
| Sets the parameter alternate name. More... | |
| void | SetAlternatename (const char *parameterAlternatename) |
| Sets the parameter alternate name. More... | |
| void | SetCategory (const NXString ¶meterCategory) |
| Sets the parameter category. More... | |
| void | SetCategory (const char *parameterCategory) |
| Sets the parameter category. More... | |
| void | SetDescription (const NXString ¶meterDescription) |
| Sets the parameter description. More... | |
| void | SetDescription (const char *parameterDescription) |
| Sets the parameter description. More... | |
| void | SetId (int parameterId) |
| Sets the parameter id. More... | |
| void | SetParameterCategory (const NXString ¶meterCategory) |
| Sets the parameter category using international character set. More... | |
| void | SetParameterCategory (const char *parameterCategory) |
| Sets the parameter category using international character set. More... | |
| void | SetParameterEditable (bool isEditable) |
| Sets whether a parameter can be modified or not. More... | |
| void | SetSubcategory (const NXString ¶meterSubcategory) |
| Sets the parameter sub-category. More... | |
| void | SetSubcategory (const char *parameterSubcategory) |
| Sets the parameter sub-category. More... | |
| void | UnassignAllObjects () |
| Removes the parameter assignment from all the objects that has it currently assigned. More... | |
| void | UpdateParameterProperties () |
| Re-synchronizes a parameter with its definition. More... | |
 Public Member Functions inherited from NXOpen::NXObject | |
| NXOpen::AttributeIterator * | CreateAttributeIterator () |
| Create an attribute iterator. More... | |
| void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type) |
| Deletes all attributes of a specific type. More... | |
| void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
| Deletes all attributes of a specific type with the option to update or not. More... | |
| void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title) |
| Deletes an attribute by type and title. More... | |
| void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title) |
| Deletes an attribute by type and title. More... | |
| void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option) |
| Deletes an attribute by type and title with the option to update or not. More... | |
| void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option) |
| Deletes an attribute by type and title with the option to update or not. More... | |
| void | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option) |
| Deletes the first attribute encountered with the given Type, Title. More... | |
| void | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option) |
| Deletes the first attribute encountered with the given Type, Title. More... | |
| void | DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option) |
| Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More... | |
| void | DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
| Deletes the attributes encountered with the given Type with option to update or not. More... | |
| virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
| Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
| virtual NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
| Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type) |
| Gets all the attribute titles of a specific type. More... | |
| bool | GetBooleanUserAttribute (const NXString &title, int index) |
| Gets a boolean attribute by Title and array Index. More... | |
| bool | GetBooleanUserAttribute (const char *title, int index) |
| Gets a boolean attribute by Title and array Index. More... | |
| NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const NXString &title, int index) |
| Gets a time attribute by Title and array Index. More... | |
| NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const char *title, int index) |
| Gets a time attribute by Title and array Index. More... | |
| int | GetIntegerAttribute (const NXString &title) |
| Gets an integer attribute by title. More... | |
| int | GetIntegerAttribute (const char *title) |
| Gets an integer attribute by title. More... | |
| int | GetIntegerUserAttribute (const NXString &title, int index) |
| Gets an integer attribute by Title and array Index. More... | |
| int | GetIntegerUserAttribute (const char *title, int index) |
| Gets an integer attribute by Title and array Index. More... | |
| bool | GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info) |
| Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More... | |
| NXString | GetPdmReferenceAttributeValue (const NXString &attributeTitle) |
| Gets the value of PDM Reference attribute for given object. More... | |
| NXString | GetPdmReferenceAttributeValue (const char *attributeTitle) |
| Gets the value of PDM Reference attribute for given object. More... | |
| double | GetRealAttribute (const NXString &title) |
| Gets a real attribute by title. More... | |
| double | GetRealAttribute (const char *title) |
| Gets a real attribute by title. More... | |
| double | GetRealUserAttribute (const NXString &title, int index) |
| Gets a real attribute by Title and array Index. More... | |
| double | GetRealUserAttribute (const char *title, int index) |
| Gets a real attribute by Title and array Index. More... | |
| NXString | GetReferenceAttribute (const NXString &title) |
| Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
| NXString | GetReferenceAttribute (const char *title) |
| Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
| NXString | GetStringAttribute (const NXString &title) |
| Gets a string attribute value by title. More... | |
| NXString | GetStringAttribute (const char *title) |
| Gets a string attribute value by title. More... | |
| NXString | GetStringUserAttribute (const NXString &title, int index) |
| Gets a string attribute by Title and array Index. More... | |
| NXString | GetStringUserAttribute (const char *title, int index) |
| Gets a string attribute by Title and array Index. More... | |
| NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title) |
| Gets a time attribute by title. More... | |
| NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title) |
| Gets a time attribute by title. More... | |
| NXString | GetTimeUserAttribute (const NXString &title, int index) |
| Gets a time attribute by Title and array Index. More... | |
| NXString | GetTimeUserAttribute (const char *title, int index) |
| Gets a time attribute by Title and array Index. More... | |
| NXOpen::NXObject::AttributeInformation | GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
| Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
| NXOpen::NXObject::AttributeInformation | GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index) |
| Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type) |
| Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type) |
| Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
| NXString | GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
| Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
| NXString | GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index) |
| Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
| int | GetUserAttributeCount (NXOpen::AttributeIterator *iterator) |
| Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
| int | GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute) |
| Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
| int | GetUserAttributeCount (NXOpen::NXObject::AttributeType type) |
| Gets the count of set attributes on the object, if any, of the given type. More... | |
| int | GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute) |
| Gets the count of attributes on the object, if any, of the given type. More... | |
| bool | GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type) |
| Determine the lock of the given attribute. More... | |
| bool | GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type) |
| Determine the lock of the given attribute. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (NXOpen::AttributeIterator *iterator) |
| Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes () |
| Gets all the attributes that have been set on the given object. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset) |
| Gets all the attributes of the given object. More... | |
| std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset, bool addStringValues) |
| Gets all the attributes of the given object. More... | |
| std::vector< NXString > | GetUserAttributesAsStrings () |
| Gets all the attributes that have been set on the given object. More... | |
| int | GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type) |
| Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
| int | GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type) |
| Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
| std::vector< NXOpen::NXObject * > | GetUserAttributeSourceObjects () |
| Returns an array of objects from which this object presents attributes. More... | |
| bool | HasUserAttribute (NXOpen::AttributeIterator *iterator) |
| Determines if an attribute exists on the object, that satisfies the given iterator. More... | |
| bool | HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
| Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
| bool | HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index) |
| Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
| virtual bool | IsOccurrence () |
| Returns whether this object is an occurrence or not. More... | |
| virtual NXString | JournalIdentifier () |
| Returns the identifier that would be recorded in a journal for this object. More... | |
| virtual NXString | Name () |
| Returns the custom name of the object. More... | |
| virtual NXOpen::Assemblies::Component * | OwningComponent () |
| Returns the owning component, if this object is an occurrence. More... | |
| virtual NXOpen::BasePart * | OwningPart () |
| Returns the owning part of this object Created in NX3.0.0. More... | |
| virtual void | Print () |
| Prints a representation of this object to the system log file. More... | |
| virtual NXOpen::INXObject * | Prototype () |
| Returns the prototype of this object if it is an occurrence. More... | |
| void | SetAttribute (const NXString &title, int value) |
| Creates or modifies an integer attribute. More... | |
| void | SetAttribute (const char *title, int value) |
| Creates or modifies an integer attribute. More... | |
| void | SetAttribute (const NXString &title, int value, NXOpen::Update::Option option) |
| Creates or modifies an integer attribute with the option to update or not. More... | |
| void | SetAttribute (const char *title, int value, NXOpen::Update::Option option) |
| Creates or modifies an integer attribute with the option to update or not. More... | |
| void | SetAttribute (const NXString &title, double value) |
| Creates or modifies a real attribute. More... | |
| void | SetAttribute (const char *title, double value) |
| Creates or modifies a real attribute. More... | |
| void | SetAttribute (const NXString &title, double value, NXOpen::Update::Option option) |
| Creates or modifies a real attribute with the option to update or not. More... | |
| void | SetAttribute (const char *title, double value, NXOpen::Update::Option option) |
| Creates or modifies a real attribute with the option to update or not. More... | |
| void | SetAttribute (const NXString &title, const NXString &value) |
| Creates or modifies a string attribute. More... | |
| void | SetAttribute (const char *title, const char *value) |
| Creates or modifies a string attribute. More... | |
| void | SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
| Creates or modifies a string attribute with the option to update or not. More... | |
| void | SetAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
| Creates or modifies a string attribute with the option to update or not. More... | |
| void | SetAttribute (const NXString &title) |
| Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
| void | SetAttribute (const char *title) |
| Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
| void | SetAttribute (const NXString &title, NXOpen::Update::Option option) |
| Creates or modifies a null attribute with the option to update or not. More... | |
| void | SetAttribute (const char *title, NXOpen::Update::Option option) |
| Creates or modifies a null attribute with the option to update or not. More... | |
| void | SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option) |
| Creates or modifies a boolean attribute with the option to update or not. More... | |
| void | SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option) |
| Creates or modifies a boolean attribute with the option to update or not. More... | |
| virtual void | SetName (const NXString &name) |
| Sets the custom name of the object. More... | |
| virtual void | SetName (const char *name) |
| Sets the custom name of the object. More... | |
| void | SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue) |
| Sets the value of PDM Reference attribute on the object. More... | |
| void | SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue) |
| Sets the value of PDM Reference attribute on the object. More... | |
| void | SetReferenceAttribute (const NXString &title, const NXString &value) |
| Creates or modifies a string attribute which uses a reference string. More... | |
| void | SetReferenceAttribute (const char *title, const char *value) |
| Creates or modifies a string attribute which uses a reference string. More... | |
| void | SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
| Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
| void | SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
| Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
| void | SetTimeAttribute (const NXString &title, const NXString &value) |
| Creates or modifies a time attribute. More... | |
| void | SetTimeAttribute (const char *title, const char *value) |
| Creates or modifies a time attribute. More... | |
| void | SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| void | SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| void | SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| void | SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| void | SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| void | SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
| Creates or modifies a time attribute with the option to update or not. More... | |
| void | SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option) |
| Creates or modifies an attribute with the option to update or not. More... | |
| void | SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option) |
| Creates or modifies an integer attribute with the option to update or not. More... | |
| void | SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option) |
| Creates or modifies an integer attribute with the option to update or not. More... | |
| void | SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option) |
| Creates or modifies a real attribute with the option to update or not. More... | |
| void | SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option) |
| Creates or modifies a real attribute with the option to update or not. More... | |
| void | SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option) |
| Creates or modifies a string attribute with the option to update or not. More... | |
| void | SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option) |
| Creates or modifies a string attribute with the option to update or not. More... | |
| void | SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option) |
| Creates or modifies a null attribute with the option to update or not. More... | |
| void | SetUserAttribute (const char *title, int index, NXOpen::Update::Option option) |
| Creates or modifies a null attribute with the option to update or not. More... | |
| void | SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock) |
| Lock or unlock the given attribute. More... | |
| void | SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock) |
| Lock or unlock the given attribute. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Additional Inherited Members | |
| Public Types inherited from NXOpen::NXObject | |
| enum | AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 } |
| Specifies attribute type. More... | |
| enum | DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual } |
| Specifies the format of the date and time attribute. More... | |
Represents Parameter
Created in NX1847.0.0.
| NXOpen::ParamLibParameter* NXOpen::ParamLibParameter::Copy | ( | NXOpen::NXObject * | partObject | ) |
Creates new (copied) parameter with same properties as the original parameter.
The name of the new (copied) parameter will be unique and based on the name of the original parameter.
| partObject | object in part where to copy parameter to |
| NXOpen::ParamLibParameter* NXOpen::ParamLibParameter::CopyLibParamToPart | ( | NXOpen::NXObject * | partObject | ) |
Copies a library parameter to a part.
| partObject | object in part where to copy parameter to |
| NXOpen::ParamLibParameter* NXOpen::ParamLibParameter::CopyLibParamToPart | ( | NXOpen::NXObject * | partObject, |
| bool | editable | ||
| ) |
Copies a library parameter to a part.
The copied (local) parameter can either be set to be editable or non-editable which determines whether the parameter can be modified or not.
| partObject | object in part where to copy parameter to |
| editable | when true, creates a local parameter ready for user editting. When false, it creates an exact copy of a loaded library parameter. The difference between loading and copying with this set to false is loading will get the latest library version whereas if the library parameter passed in is not synchronized with the latest version, the copy will also not be synchronized with the latest version. |
| void NXOpen::ParamLibParameter::Delete | ( | ) |
Deletes a parameter from the part.
Created in NX1847.0.0.
License requirements : None
| void NXOpen::ParamLibParameter::DeleteOrphanedUserParameterModels | ( | ) |
Deletes Orphaned User Parameter (UPARAM) Models and Properties from a parameter.
A model or property is considered orphaned if it exists on the parameter, but doesn't exist in the current environment.
Created in NX1847.0.0.
License requirements : None
| void NXOpen::ParamLibParameter::DeleteUserParameterModels | ( | ) |
Deletes User Parameter (UPARAM) Model Property Values from a parameter.
Created in NX1847.0.0.
License requirements : None
| NXString NXOpen::ParamLibParameter::GetAlternatename | ( | ) |
Returns the parameter alternate name.
| NXString NXOpen::ParamLibParameter::GetCategory | ( | ) |
Returns the parameter category.
| NXString NXOpen::ParamLibParameter::GetDescription | ( | ) |
Returns the parameter description.
| int NXOpen::ParamLibParameter::GetId | ( | ) |
Returns the parameter id.
| NXString NXOpen::ParamLibParameter::GetLibraryName | ( | ) |
Returns the library name if the parameter was loaded from a library.
| NXString NXOpen::ParamLibParameter::GetLibraryType | ( | ) |
Returns the parameter library type this parameter belogns to.
| NXString NXOpen::ParamLibParameter::GetParameterCategory | ( | ) |
Returns the parameter category using international character set.
| bool NXOpen::ParamLibParameter::GetParameterEditable | ( | ) |
Returns whether the parameter can be modified or not.
Created in NX1847.0.0.
License requirements : None
| int NXOpen::ParamLibParameter::GetParameterType | ( | ) |
Returns the parameter type.
| void NXOpen::ParamLibParameter::GetParentlibraryparameter | ( | NXString * | parentName, |
| NXString * | parentLibraryName | ||
| ) |
Returns the parent libary parameter information.
Created in NX1847.0.0.
License requirements : None
| parentName | parentname |
| parentLibraryName | parentlibraryname |
| NXOpen::ParamLibParameter* NXOpen::ParamLibParameter::GetParentparameter | ( | ) |
Returns the parent parameter that the parameter was copied from.
| NXOpen::BasePropertyTable* NXOpen::ParamLibParameter::GetPropTable | ( | ) |
Returns the property table that contains the properties for this parameter.
Created in NX1847.0.0.
License requirements : None
| NXString NXOpen::ParamLibParameter::GetSubcategory | ( | ) |
Returns the parameter sub-category.
| NXString NXOpen::ParamLibParameter::GetTeamcenterParameterItem | ( | ) |
Returns the Teamcenter item if the parameter was loaded from Teamcenter.
| void NXOpen::ParamLibParameter::GetUsage | ( | std::vector< NXOpen::NXObject * > & | objects | ) |
Finds the objects using this parameter.
Created in NX1847.0.0.
License requirements : None
| objects | the objects using the parameter |
| NXString NXOpen::ParamLibParameter::GetVersion | ( | ) |
Returns the parameter version .
| bool NXOpen::ParamLibParameter::HasParentlibraryparameter | ( | ) |
Returns whether the parameter was copied from a library parameter.
| bool NXOpen::ParamLibParameter::HasParentparameter | ( | ) |
Returns whether the parameter was copied from another parameter.
| void NXOpen::ParamLibParameter::InfoParameter | ( | ) |
Displays the property values for the parameter in the information window.
Created in NX1847.0.0.
License requirements : None
| void NXOpen::ParamLibParameter::InfoParameterToFile | ( | bool | bOverride, |
| const NXString & | pcFileName | ||
| ) |
Writes the property values for the parameter to a file.
Created in NX1847.0.0.
License requirements : None
| bOverride | if the file already exists, true override the file, false append to the file |
| pcFileName | the full path including filename of file where the information should be written |
| void NXOpen::ParamLibParameter::InfoParameterToFile | ( | bool | bOverride, |
| const char * | pcFileName | ||
| ) |
Writes the property values for the parameter to a file.
Created in NX1847.0.0.
License requirements : None
| bOverride | if the file already exists, true override the file, false append to the file |
| pcFileName | the full path including filename of file where the information should be written |
| bool NXOpen::ParamLibParameter::IsLoadedLibraryParameter | ( | ) |
Returns true if the parameter is loaded from a library (not Teamcenter).
| bool NXOpen::ParamLibParameter::IsLoadedTeamcenterParameterItem | ( | ) |
Returns true if the parameter is loaded from Teamcenter.
| bool NXOpen::ParamLibParameter::IsNonlibraryParameter | ( | ) |
Returns true if the parameter is locally defined (not a library/Teamcenter parameter).
| void NXOpen::ParamLibParameter::ResyncWithLibraryDefinition | ( | ) |
Re-synchronizes a loaded library parameter to match its latest library definition.
Created in NX1847.0.0.
License requirements : None
| void NXOpen::ParamLibParameter::SetAlternatename | ( | const NXString & | parameterAlternatename | ) |
Sets the parameter alternate name.
Created in NX1847.0.0.
License requirements : None
| parameterAlternatename | the alternate name for the parameter |
| void NXOpen::ParamLibParameter::SetAlternatename | ( | const char * | parameterAlternatename | ) |
Sets the parameter alternate name.
Created in NX1847.0.0.
License requirements : None
| parameterAlternatename | the alternate name for the parameter |
| void NXOpen::ParamLibParameter::SetCategory | ( | const NXString & | parameterCategory | ) |
Sets the parameter category.
Created in NX1847.0.0.
License requirements : None
| parameterCategory | the category for the parameter |
| void NXOpen::ParamLibParameter::SetCategory | ( | const char * | parameterCategory | ) |
Sets the parameter category.
Created in NX1847.0.0.
License requirements : None
| parameterCategory | the category for the parameter |
| void NXOpen::ParamLibParameter::SetDescription | ( | const NXString & | parameterDescription | ) |
Sets the parameter description.
Created in NX1847.0.0.
License requirements : None
| parameterDescription | the description for the parameter |
| void NXOpen::ParamLibParameter::SetDescription | ( | const char * | parameterDescription | ) |
Sets the parameter description.
Created in NX1847.0.0.
License requirements : None
| parameterDescription | the description for the parameter |
| void NXOpen::ParamLibParameter::SetId | ( | int | parameterId | ) |
Sets the parameter id.
Created in NX1847.0.0.
License requirements : None
| parameterId | the id for the parameter |
| void NXOpen::ParamLibParameter::SetParameterCategory | ( | const NXString & | parameterCategory | ) |
Sets the parameter category using international character set.
Created in NX1847.0.0.
License requirements : None
| parameterCategory | the category for the parameter |
| void NXOpen::ParamLibParameter::SetParameterCategory | ( | const char * | parameterCategory | ) |
Sets the parameter category using international character set.
Created in NX1847.0.0.
License requirements : None
| parameterCategory | the category for the parameter |
| void NXOpen::ParamLibParameter::SetParameterEditable | ( | bool | isEditable | ) |
Sets whether a parameter can be modified or not.
Note: library parameters cannot be set to be able to be modified.
Created in NX1847.0.0.
License requirements : None
| isEditable | iseditable |
| void NXOpen::ParamLibParameter::SetSubcategory | ( | const NXString & | parameterSubcategory | ) |
Sets the parameter sub-category.
Created in NX1847.0.0.
License requirements : None
| parameterSubcategory | the subcategory for the parameter |
| void NXOpen::ParamLibParameter::SetSubcategory | ( | const char * | parameterSubcategory | ) |
Sets the parameter sub-category.
Created in NX1847.0.0.
License requirements : None
| parameterSubcategory | the subcategory for the parameter |
| void NXOpen::ParamLibParameter::UnassignAllObjects | ( | ) |
Removes the parameter assignment from all the objects that has it currently assigned.
Created in NX1847.0.0.
License requirements : None
| void NXOpen::ParamLibParameter::UpdateParameterProperties | ( | ) |
Re-synchronizes a parameter with its definition.
The definition could be a library definition or a parent parameter's (from a copy) definition.
Created in NX1847.0.0.
License requirements : None
