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

A NXOpen::Routing::StockData contains the various profiles, characteristic information, NXOpen::Routing::Anchor and other attributes that define NXOpen::Routing::Stock objects. More...

Inheritance diagram for NXOpen::Routing::StockData:
NXOpen::NXObject NXOpen::Routing::ICharacteristic NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Public Member Functions

virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
 Removes the input list of characteristics from this object. More...
 
std::vector
< NXOpen::Routing::Anchor * > 
GetAnchors ()
 Gets the list of NXOpen::Routing::Anchor objects associated with this NXOpen::Routing::StockData . More...
 
std::vector
< NXOpen::Routing::StockData * > 
GetBundledStockDatas ()
 Returns all of the NXOpen::Routing::StockData that were used to build this object by the bundling algorithm. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object. More...
 
std::vector
< NXOpen::Routing::CrossSection * > 
GetCrossSections ()
 Gets the list of NXOpen::Routing::CrossSection objects associated with this NXOpen::Routing::StockData . More...
 
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object. More...
 
virtual int GetIntegerCharacteristic (const NXString &name)
 Get the value of an integer characteristic associated with the input name. More...
 
virtual int GetIntegerCharacteristic (const char *name)
 Get the value of an integer characteristic associated with the input name. More...
 
NXOpen::Routing::StockDataType GetIsBundled ()
 Returns whether or not the NXOpen::Routing::StockData is used in the bundling of wires or not. More...
 
NXOpen::Routing::AnchorGetNamedAnchor (const NXString &anchorName)
 Returns the NXOpen::Routing::Anchor which is part of the Routing::StockData , given the anchors name. More...
 
NXOpen::Routing::AnchorGetNamedAnchor (const char *anchorName)
 Returns the NXOpen::Routing::Anchor which is part of the Routing::StockData , given the anchors name. More...
 
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const char *name)
 Get the value of a real characteristic associated with the input name. More...
 
std::vector
< NXOpen::Routing::Stock * > 
GetStocks ()
 Returns all of the NXOpen::Routing::Stock objects that use this NXOpen::Routing::StockData object. More...
 
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const char *name)
 Get the value of a string characteristic associated with the input name. More...
 
NXOpen::Routing::CrossSectionGetStyledCross (NXOpen::Routing::StockStyle stockStyle)
 Returns the NXOpen::Routing::CrossSection which is part of the Routing::StockData , given the cross section style. More...
 
void SetAnchors (const std::vector< NXOpen::Routing::Anchor * > &anchors)
 Sets the list of NXOpen::Routing::Anchor objects associated with this NXOpen::Routing::StockData . More...
 
virtual void SetCharacteristic (const NXString &name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const char *name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const NXString &name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const char *name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const NXString &name, const NXString &value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const char *name, const char *value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
 Set all of the characteristics values on this object. More...
 
void SetCrossSections (const std::vector< NXOpen::Routing::CrossSection * > &crossSections)
 Sets the list of NXOpen::Routing::CrossSection objects associated with this NXOpen::Routing::StockData . More...
 
- Public Member Functions inherited from NXOpen::NXObject
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::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (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...
 
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::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 ()
 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< NXStringGetUserAttributesAsStrings ()
 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 (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::BasePartOwningPart ()
 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::INXObjectPrototype ()
 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 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...
 

Detailed Description

A NXOpen::Routing::StockData contains the various profiles, characteristic information, NXOpen::Routing::Anchor and other attributes that define NXOpen::Routing::Stock objects.

Each NXOpen::Routing::Stock has exactly one NXOpen::Routing::StockData associated with it. All NXOpen::Routing::CrossSection and NXOpen::Routing::Anchor objects used in a NXOpen::Routing::Stock object must come from the NXOpen::Routing::StockData associated with that NXOpen::Routing::Stock object.
Creator not available in KF because transient objects are not supported.

Created in NX4.0.0.

Member Function Documentation

virtual void NXOpen::Routing::StockData::DeleteCharacterstics ( NXOpen::Routing::CharacteristicList values)
virtual

Removes the input list of characteristics from this object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

std::vector<NXOpen::Routing::Anchor *> NXOpen::Routing::StockData::GetAnchors ( )

Gets the list of NXOpen::Routing::Anchor objects associated with this NXOpen::Routing::StockData .

There should be no more than one NXOpen::Routing::Anchor with the same name.

Returns
The list of NXOpen::Routing::Anchor objects.
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
std::vector<NXOpen::Routing::StockData *> NXOpen::Routing::StockData::GetBundledStockDatas ( )

Returns all of the NXOpen::Routing::StockData that were used to build this object by the bundling algorithm.

Only returns valid output if NXOpen::Routing::StockData::GetIsBundled returns Routing::StockDataTypeBundled .

Returns

Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::StockData::GetCharacteristics ( )
virtual

Get all of the characteristics values on the this object.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

std::vector<NXOpen::Routing::CrossSection *> NXOpen::Routing::StockData::GetCrossSections ( )

Gets the list of NXOpen::Routing::CrossSection objects associated with this NXOpen::Routing::StockData .

There should be no more than one NXOpen::Routing::CrossSection of any particular NXOpen::Routing::StockStyle (and no NXOpen::Routing::CrossSection with a style of NXOpen::Routing::StockStyleNone ).

Returns
The list of NXOpen::Routing::CrossSection objects.
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::StockData::GetDestinationCharacteristics ( )
virtual

Returns the destination characteristics from the input object.

Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

  • Ports: Reads characteristics from the port.
  • RCPs: Attempts to find a port at the RCP, reads characteristics from the port if it exists, otherwise reads from the stock associated with the rcp.
  • Segments: Reads characteristics from the stock associated with the segment.
  • Components: Reads characteristics directly from the component.
  • Stock: Reads characteristics from the stock or from the stock's data.
Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

virtual int NXOpen::Routing::StockData::GetIntegerCharacteristic ( const NXString name)
virtual

Get the value of an integer characteristic associated with the input name.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

virtual int NXOpen::Routing::StockData::GetIntegerCharacteristic ( const char *  name)
virtual

Get the value of an integer characteristic associated with the input name.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

NXOpen::Routing::StockDataType NXOpen::Routing::StockData::GetIsBundled ( )

Returns whether or not the NXOpen::Routing::StockData is used in the bundling of wires or not.

Returns

Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Anchor* NXOpen::Routing::StockData::GetNamedAnchor ( const NXString anchorName)

Returns the NXOpen::Routing::Anchor which is part of the Routing::StockData , given the anchors name.

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
anchorName
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::Routing::Anchor* NXOpen::Routing::StockData::GetNamedAnchor ( const char *  anchorName)

Returns the NXOpen::Routing::Anchor which is part of the Routing::StockData , given the anchors name.

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
anchorName
NOTE: The full Unicode character set is not supported for this parameter.
virtual double NXOpen::Routing::StockData::GetRealCharacteristic ( const NXString name)
virtual

Get the value of a real characteristic associated with the input name.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

virtual double NXOpen::Routing::StockData::GetRealCharacteristic ( const char *  name)
virtual

Get the value of a real characteristic associated with the input name.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::StockData::GetStocks ( )

Returns all of the NXOpen::Routing::Stock objects that use this NXOpen::Routing::StockData object.

Returns

Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
virtual NXString NXOpen::Routing::StockData::GetStringCharacteristic ( const NXString name)
virtual

Get the value of a string characteristic associated with the input name.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

virtual NXString NXOpen::Routing::StockData::GetStringCharacteristic ( const char *  name)
virtual

Get the value of a string characteristic associated with the input name.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

NXOpen::Routing::CrossSection* NXOpen::Routing::StockData::GetStyledCross ( NXOpen::Routing::StockStyle  stockStyle)

Returns the NXOpen::Routing::CrossSection which is part of the Routing::StockData , given the cross section style.

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
stockStylestock style
void NXOpen::Routing::StockData::SetAnchors ( const std::vector< NXOpen::Routing::Anchor * > &  anchors)

Sets the list of NXOpen::Routing::Anchor objects associated with this NXOpen::Routing::StockData .

There should be no more than one NXOpen::Routing::Anchor with the same name.
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
anchorsThe list of NXOpen::Routing::Anchor objects.
virtual void NXOpen::Routing::StockData::SetCharacteristic ( const NXString name,
int  value 
)
virtual

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::SetCharacteristic ( const char *  name,
int  value 
)
virtual

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::SetCharacteristic ( const NXString name,
double  value 
)
virtual

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::SetCharacteristic ( const char *  name,
double  value 
)
virtual

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::SetCharacteristic ( const NXString name,
const NXString value 
)
virtual

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::SetCharacteristic ( const char *  name,
const char *  value 
)
virtual

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
name
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::SetCharacteristics ( NXOpen::Routing::CharacteristicList values)
virtual

Set all of the characteristics values on this object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::StockData::SetCrossSections ( const std::vector< NXOpen::Routing::CrossSection * > &  crossSections)

Sets the list of NXOpen::Routing::CrossSection objects associated with this NXOpen::Routing::StockData .

There should be no more than one NXOpen::Routing::CrossSection of any particular NXOpen::Routing::StockStyle (and no NXOpen::Routing::CrossSection with a style of NXOpen::Routing::StockStyleNone ).
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
crossSectionsThe list of NXOpen::Routing::CrossSection objects.

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