NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Weld::CharacteristicsValueBuilder Class Reference

The object containing the information about the attribute to be placed on the output of the weld feature. More...

Inheritance diagram for NXOpen::Weld::CharacteristicsValueBuilder:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  Type {
  TypeString, TypeInteger, TypeDouble, TypeOption,
  TypeNone
}
 Settings to indicate the type of value contained in the attribute. More...

Public Member Functions

bool Active ()
 Returns the indication if the attribute is to be placed on the output.
NXOpen::Weld::CharacteristicsValueBuilder::Type AttributeType ()
 Returns the type of this attribute.
void GetOptionStrings (std::vector< NXString > &strings)
 The list of strings that are available to be set when AttributeType is Weld::CharacteristicsValueBuilder::TypeOption .
bool Required ()
 Returns the indication if the attribute is required to be placed on the output.
void SetActive (bool active)
 Sets the indication if the attribute is to be placed on the output.
void SetValueChanged (bool status)
 Sets the indication if the attribute value has been changed.
void SetValueDouble (double valueDouble)
 Sets the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeDouble .
void SetValueInteger (int valueInteger)
 Sets the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeInteger .
void SetValueString (const NXString &valueString)
 Sets the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeString or Weld::CharacteristicsValueBuilder::TypeOption .
NXString Title ()
 Returns the title of this attribute.
bool ValueChanged ()
 Returns the indication if the attribute value has been changed.
double ValueDouble ()
 Returns the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeDouble .
int ValueInteger ()
 Returns the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeInteger .
NXString ValueString ()
 Returns the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeString or Weld::CharacteristicsValueBuilder::TypeOption .

Detailed Description

The object containing the information about the attribute to be placed on the output of the weld feature.


Created in NX7.5.0.


Member Enumeration Documentation

Settings to indicate the type of value contained in the attribute.

Enumerator:
TypeString 

Indicates the attribute value contains a string.

TypeInteger 

Indicates the attribute value contains a integer.

TypeDouble 

Indicates the attribute value contains a double.

TypeOption 

Indicates the attribute value contains a pre set list of strings.

TypeNone 

Indicates there is no attribute value.


Member Function Documentation

Returns the indication if the attribute is to be placed on the output.

true indicates the attribute will be placed on the output, false indicates the attribute will not be placed on the output. Note that if Required is true, then this property cannot be set.
Created in NX7.5.0.

License requirements : None

Returns the type of this attribute.


Created in NX7.5.0.

License requirements : None

The list of strings that are available to be set when AttributeType is Weld::CharacteristicsValueBuilder::TypeOption .


Created in NX7.5.0.

License requirements : None

Parameters:
stringsStrings that are allowed for values.

Returns the indication if the attribute is required to be placed on the output.

true indicates the attribute will always be placed on the output, false indicates the attribute does not have to be placed on the output.
Created in NX7.5.0.

License requirements : None

Sets the indication if the attribute is to be placed on the output.

true indicates the attribute will be placed on the output, false indicates the attribute will not be placed on the output. Note that if Required is true, then this property cannot be set.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters:
activeactive

Sets the indication if the attribute value has been changed.


Created in NX8.0.1.

License requirements : ugweld ("UG WELD")

Parameters:
statusstatus

Sets the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeDouble .


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters:
valueDoublevaluedouble

Sets the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeInteger .


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters:
valueIntegervalueinteger

Sets the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeString or Weld::CharacteristicsValueBuilder::TypeOption .


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters:
valueStringvaluestring

Returns the title of this attribute.


Created in NX7.5.0.

License requirements : None

Returns the indication if the attribute value has been changed.


Created in NX8.0.1.

License requirements : None

Returns the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeDouble .


Created in NX7.5.0.

License requirements : None

Returns the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeInteger .


Created in NX7.5.0.

License requirements : None

Returns the value of this attribute when AttributeType is Weld::CharacteristicsValueBuilder::TypeString or Weld::CharacteristicsValueBuilder::TypeOption .


Created in NX7.5.0.

License requirements : None


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