NX Open C++ Reference Guide
|
The NXOpen::Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments. More...
Public Member Functions | |
void | AddSegments (const std::vector< NXOpen::Curve * > &segments) |
Adds new segments to this object. More... | |
void | AlignStock (const NXOpen::Vector3d &vector) |
Align stock to new rotation vector. More... | |
void | ColorBodies () |
Colors the solid bodies of the stock based on the COLOR characteristic specified in the NXOpen::Routing::StockData of the stock. More... | |
virtual void | DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values) |
Removes the input list of characteristics from this object. More... | |
NXOpen::Routing::Anchor * | GetAnchor () |
Gets the NXOpen::Routing::Anchor that currently modifies the profile for the stock. More... | |
std::vector< NXOpen::Body * > | GetBodies () |
Returns the solid bodies, if any, that are created and controlled by this object. More... | |
void | GetBodySegmentMap (NXOpen::Features::Feature *feature, NXOpen::Body **body, std::vector< NXOpen::Curve * > &stockSegments, std::vector< NXOpen::Curve * > &pathSegments) |
Given stock and a feature of the stock, returns solid body, stock segments and path segments that produced the body. More... | |
virtual NXOpen::Routing::CharacteristicList * | GetCharacteristics () |
Get all of the characteristics values on the this object. More... | |
NXOpen::Assemblies::Component * | GetComponent () |
Returns the NXOpen::Assemblies::Component created and controlled by the stock for a Stock as Components stock. More... | |
NXOpen::Routing::CrossSection * | GetCrossSection () |
Gets the NXOpen::Routing::CrossSection that currently defines the profile for the stock. More... | |
virtual NXOpen::Routing::CharacteristicList * | GetDestinationCharacteristics () |
Returns the destination characteristics from the input object. More... | |
std::vector < NXOpen::Features::Feature * > | GetFeatures () |
Returns the sweep features that are created and controlled by this object. More... | |
NXOpen::Routing::Flip | GetFlippedStatus () |
Gets whether or not the profile is flipped. More... | |
NXOpen::Routing::Electrical::HarnessDevice * | GetHarnessDevice () |
For Routing Electrical application only, returns the Routing::Electrical::HarnessDevice that owns the wire or wires that make up a stock bundle. 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::ComponentName | GetNameStatus () |
Returns whether or not the component associated with a Stock as Components Stock has a permanent or temporary name. More... | |
double | GetOriginalLength () |
Returns the original length for a stock that has been deformed (it's use is Routing::StockUseDeformed ). More... | |
void | GetPorts (NXOpen::Routing::StockPort **startPort, NXOpen::Routing::StockPort **endPort) |
Returns the NXOpen::Routing::StockPort at each end of the stock. More... | |
NXOpen::Routing::ProfileFrom | GetProfileEnd () |
Gets the end that defines profile. 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... | |
double | GetRotationAngle () |
Gets the rotation angle applied to the profile. More... | |
std::vector< NXOpen::Curve * > | GetSegments () |
Gets the segments that the NXOpen::Routing::Stock object is placed on top of. More... | |
NXOpen::Routing::StockData * | GetStockData () |
Gets the NXOpen::Routing::StockData . More... | |
NXOpen::Routing::StockStyle | GetStockStyle () |
Gets the NXOpen::Routing::StockStyle of the NXOpen::Routing::Stock . More... | |
NXOpen::Routing::StockUse | GetStockUse () |
Returns the use of the stock. 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... | |
double | GetTwistAngle () |
Gets the twist angle applied to the profile. More... | |
bool | IsSpaceReservation () |
Is this stock a Space Reservation stock?. More... | |
bool | NegateOffsetsFlag () |
Returns the negate offsets flag of this NXOpen::Routing::Stock . More... | |
void | RemoveSegments (const std::vector< NXOpen::Curve * > &segments) |
Removes segments from this object. More... | |
void | RenameStockComponent (const NXString &partName) |
Renames the stock component part with given name Created in NX7.5.4. More... | |
void | RenameStockComponent (const char *partName) |
Renames the stock component part with given name Created in NX7.5.4. More... | |
void | SetAnchor (NXOpen::Routing::Anchor *anchor) |
Sets the NXOpen::Routing::Anchor . 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 | SetCharacteristic2 (const NXString &title, int value) |
Sets or creates an integer type attribute associated with the input title. More... | |
virtual void | SetCharacteristic2 (const char *title, int value) |
Sets or creates an integer type attribute associated with the input title. More... | |
virtual void | SetCharacteristic2 (const NXString &title, double value) |
Sets or creates a double type attribute associated with the input title. More... | |
virtual void | SetCharacteristic2 (const char *title, double value) |
Sets or creates a double type attribute associated with the input title. More... | |
virtual void | SetCharacteristic2 (const NXString &title, const NXString &value) |
Sets or creates a string type type attribute associated with the input title. More... | |
virtual void | SetCharacteristic2 (const char *title, const char *value) |
Sets or creates a string type type attribute associated with the input title. More... | |
virtual void | SetCharacteristics (NXOpen::Routing::CharacteristicList *values) |
Set all of the characteristics values on this object. More... | |
virtual void | SetCharacteristics2 (NXOpen::Routing::CharacteristicList *values) |
Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More... | |
void | SetCrossSection (NXOpen::Routing::CrossSection *crossSection) |
Sets the NXOpen::Routing::CrossSection . More... | |
void | SetFlippedStatus (NXOpen::Routing::Flip flipped) |
Sets whether or not the profile is flipped. More... | |
void | SetNegateOffsetsFlag (bool offsetFlag) |
Sets the negate offsets flag of this NXOpen::Routing::Stock . More... | |
void | SetProfileEnd (NXOpen::Routing::ProfileFrom profileEnd) |
Sets the end that defines profile. More... | |
void | SetRotationAngle (double rotationAngle) |
Sets the rotation angle applied to the profile. More... | |
void | SetStockData (NXOpen::Routing::StockData *stockData) |
Sets the NXOpen::Routing::StockData . More... | |
void | SetStockStyle (NXOpen::Routing::StockStyle style) |
Sets the NXOpen::Routing::StockStyle of the NXOpen::Routing::Stock . More... | |
void | SetTwistAngle (double twistAngle) |
Sets the twist angle applied to the profile. More... | |
void | SyncComponentAttrs (bool isNewPart) |
Set the characteristics of the given stock's component so that it has the same characteristics as the NXOpen::Routing::Stock and its stock data. 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... | |
The NXOpen::Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments.
The material is defined in the NXOpen::Routing::StockData object. NXOpen::Routing::Stock consists of a NXOpen::Routing::StockData object, as well as references to at most one of the NXOpen::Routing::CrossSection and NXOpen::Routing::Anchor objects that are associated with that NXOpen::Routing::StockData .
A NXOpen::Routing::Stock object may exist in one of two modes ; Legacy Stock or Stock as Components Stock. Legacy Stock is modeled as a sweep feature in the work part. Stock as Components Stock is modeled as a child component (of the work part) that contains a sweep feature. Legacy Stock and Stock as Components stock cannot exist in the same part file with the exception of Bundled stock.
Stock as Components Stock creates a component file, and creates a copy of itself inside of that part file. Segments, anchors, and all other necessary information are copied into the component part file. The stock inside of the component file should not be edited or modified as it is completely controlled by the Stock as Component Stock in the work part.
NXOpen::Routing::Stock object that have automatically been generated by the bundling algorithm used for routing wires are Bundled stock. Bundled stocks are always created as Legacy Stocks (even in parts containing Stock as Component stocks). Any NXOpen::Routing::StockData object that defines a bundled stock has a type of Routing::StockDataTypeBundled . Editing the segments or the stock data of a Bundled stock may result in undefined behavior.
With the exception of stock style, there are no functional differences between the two stock types. Stock as Components Stock always uses the NXOpen::Routing::StockStyleDetailed style (if available, otherwise it uses the NXOpen::Routing::StockStyleSimple style) and the stock's style cannot be changed.
Creator not available in KF because transient objects are not supported.
Created in NX4.0.0.
void NXOpen::Routing::Stock::AddSegments | ( | const std::vector< NXOpen::Curve * > & | segments | ) |
Adds new segments to this object.
If the new segments (added to the old segments) do not form a single continuous path, the NXOpen::Routing::Stock will split so that there is a copy of this object on each continuous path formed by the input segments.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
segments | List of segments to add. Ignores any segments that are already referenced by this object. |
void NXOpen::Routing::Stock::AlignStock | ( | const NXOpen::Vector3d & | vector | ) |
Align stock to new rotation vector.
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
vector | Rotation vector. |
void NXOpen::Routing::Stock::ColorBodies | ( | ) |
Colors the solid bodies of the stock based on the COLOR characteristic specified in the NXOpen::Routing::StockData of the stock.
The color string can contain the name of a color, a hex string specifying the RGB values, a comma separated list of RGB integer values and a simple integer specifying the color index directly.
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
|
virtual |
Removes the input list of characteristics from this object.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
values | values |
Implements NXOpen::Routing::ICharacteristic.
NXOpen::Routing::Anchor* NXOpen::Routing::Stock::GetAnchor | ( | ) |
Gets the NXOpen::Routing::Anchor that currently modifies the profile for the stock.
std::vector<NXOpen::Body *> NXOpen::Routing::Stock::GetBodies | ( | ) |
Returns the solid bodies, if any, that are created and controlled by this object.
For Stock as Components stock, the bodies exist in a separate part file. For Legacy Stock the bodies exist in the same part as the input object.
void NXOpen::Routing::Stock::GetBodySegmentMap | ( | NXOpen::Features::Feature * | feature, |
NXOpen::Body ** | body, | ||
std::vector< NXOpen::Curve * > & | stockSegments, | ||
std::vector< NXOpen::Curve * > & | pathSegments | ||
) |
Given stock and a feature of the stock, returns solid body, stock segments and path segments that produced the body.
Path segments are the visible segments over which the stock is created. Stock segments may be same as the path segments or those may be hidden segments created for the stock. In case of NXOpen::Routing::Overstock stockSegments are hidden and path segments are visible. There may be many stock segments created on a single path segment in that case. Usage: 1. Query features for a stock. If an overstock is applied on a path with a sharp corner, it may have created multiple features. 2.Call this method for every feature in a loop.
Created in NX11.0.1.
License requirements : routing_base ("Routing Basic")
feature | Stock sweep feature. |
body | Solid body of the stock sweep. |
stockSegments | Stock segments. Hidden segments in case of overstocks. |
pathSegments | Path segments. Same as stock segments for stock but visible path segments for overstock. |
|
virtual |
Get all of the characteristics values on the this object.
Implements NXOpen::Routing::ICharacteristic.
NXOpen::Assemblies::Component* NXOpen::Routing::Stock::GetComponent | ( | ) |
Returns the NXOpen::Assemblies::Component created and controlled by the stock for a Stock as Components stock.
Only returns a component if the stock type is Routing::StockUseStockAsComponent .
NXOpen::Routing::CrossSection* NXOpen::Routing::Stock::GetCrossSection | ( | ) |
Gets the NXOpen::Routing::CrossSection that currently defines the profile for the stock.
|
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
Implements NXOpen::Routing::ICharacteristic.
std::vector<NXOpen::Features::Feature *> NXOpen::Routing::Stock::GetFeatures | ( | ) |
Returns the sweep features that are created and controlled by this object.
For Stock as Components stock, the features exist in a separate part file. For Legacy Stock the features exist in the same part as the input object.
NXOpen::Routing::Flip NXOpen::Routing::Stock::GetFlippedStatus | ( | ) |
Gets whether or not the profile is flipped.
NXOpen::Routing::Electrical::HarnessDevice* NXOpen::Routing::Stock::GetHarnessDevice | ( | ) |
For Routing Electrical application only, returns the Routing::Electrical::HarnessDevice that owns the wire or wires that make up a stock bundle.
Will return NULL if this stock is not a wire, cable, or shield bundle.
|
virtual |
Get the value of an integer characteristic associated with the input name.
name | name |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Get the value of an integer characteristic associated with the input name.
name | name |
Implements NXOpen::Routing::ICharacteristic.
NXOpen::Routing::ComponentName NXOpen::Routing::Stock::GetNameStatus | ( | ) |
Returns whether or not the component associated with a Stock as Components Stock has a permanent or temporary name.
double NXOpen::Routing::Stock::GetOriginalLength | ( | ) |
Returns the original length for a stock that has been deformed (it's use is Routing::StockUseDeformed ).
This is the length of the original stock in the component part at the time that the deformed stock was created.
void NXOpen::Routing::Stock::GetPorts | ( | NXOpen::Routing::StockPort ** | startPort, |
NXOpen::Routing::StockPort ** | endPort | ||
) |
Returns the NXOpen::Routing::StockPort at each end of the stock.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
startPort | Port at the start of the first segment. |
endPort | Port at the end of the last segment. |
NXOpen::Routing::ProfileFrom NXOpen::Routing::Stock::GetProfileEnd | ( | ) |
Gets the end that defines profile.
|
virtual |
Get the value of a real characteristic associated with the input name.
name | name |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Get the value of a real characteristic associated with the input name.
name | name |
Implements NXOpen::Routing::ICharacteristic.
double NXOpen::Routing::Stock::GetRotationAngle | ( | ) |
Gets the rotation angle applied to the profile.
std::vector<NXOpen::Curve *> NXOpen::Routing::Stock::GetSegments | ( | ) |
Gets the segments that the NXOpen::Routing::Stock object is placed on top of.
NXOpen::Routing::StockData* NXOpen::Routing::Stock::GetStockData | ( | ) |
Gets the NXOpen::Routing::StockData .
NXOpen::Routing::StockStyle NXOpen::Routing::Stock::GetStockStyle | ( | ) |
Gets the NXOpen::Routing::StockStyle of the NXOpen::Routing::Stock .
NXOpen::Routing::StockUse NXOpen::Routing::Stock::GetStockUse | ( | ) |
Returns the use of the stock.
Get the value of a string characteristic associated with the input name.
name | name |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Get the value of a string characteristic associated with the input name.
name | name |
Implements NXOpen::Routing::ICharacteristic.
double NXOpen::Routing::Stock::GetTwistAngle | ( | ) |
Gets the twist angle applied to the profile.
bool NXOpen::Routing::Stock::IsSpaceReservation | ( | ) |
Is this stock a Space Reservation stock?.
bool NXOpen::Routing::Stock::NegateOffsetsFlag | ( | ) |
Returns the negate offsets flag of this NXOpen::Routing::Stock .
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::Stock::RemoveSegments | ( | const std::vector< NXOpen::Curve * > & | segments | ) |
Removes segments from this object.
If the segments of this object (after removing the input segments) do not form a single continuous path, the NXOpen::Routing::Stock will split so that there is a copy of this object on each continuous path. This object will delete itself inside of update if all segments are removed.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
segments | List of segments to remove. Ignores any segments that are not already referenced by this object. |
void NXOpen::Routing::Stock::RenameStockComponent | ( | const NXString & | partName | ) |
Renames the stock component part with given name
Created in NX7.5.4.
License requirements : routing_base ("Routing Basic")
partName | Part name to be set |
void NXOpen::Routing::Stock::RenameStockComponent | ( | const char * | partName | ) |
Renames the stock component part with given name
Created in NX7.5.4.
License requirements : routing_base ("Routing Basic")
partName | Part name to be set |
void NXOpen::Routing::Stock::SetAnchor | ( | NXOpen::Routing::Anchor * | anchor | ) |
Sets the NXOpen::Routing::Anchor .
The given object must be one of the NXOpen::Routing::Anchor objects referenced by the NXOpen::Routing::StockData object that defines this NXOpen::Routing::Stock object.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
anchor | Must be referenced by the NXOpen::Routing::StockData associated with this NXOpen::Routing::Stock object. |
|
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")
name | name |
value | value |
Implements NXOpen::Routing::ICharacteristic.
|
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")
name | name |
value | value |
Implements NXOpen::Routing::ICharacteristic.
|
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")
name | name |
value | value |
Implements NXOpen::Routing::ICharacteristic.
|
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")
name | name |
value | value |
Implements NXOpen::Routing::ICharacteristic.
|
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")
name | name |
value | value |
Implements NXOpen::Routing::ICharacteristic.
|
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")
name | name |
value | value |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets or creates an integer type attribute associated with the input title.
creating a new attribute if one doesn't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets or creates an integer type attribute associated with the input title.
creating a new attribute if one doesn't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets or creates a double type attribute associated with the input title.
creating a new attribute if one doesn't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets or creates a double type attribute associated with the input title.
creating a new attribute if one doesn't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets or creates a string type type attribute associated with the input title.
creating a new attribute if one doesn't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets or creates a string type type attribute associated with the input title.
creating a new attribute if one doesn't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create an attribute on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Set all of the characteristics values on this object.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
values | values |
Implements NXOpen::Routing::ICharacteristic.
|
virtual |
Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already.
If the method is called on a stock Assemblies::Component , the method will create or edit part attributes on the stock part. For legacy parts where the attributes are on the stock component, the attributes will be moved to the stock part.
If the method is called on a non-stock Assemblies::Component , the method will create or edit attributes on the corresponding instance. For legacy parts where the attribute is on the component, the attributes will be moved to the corresponding instance.
If the method is called on any non-component object, the method will access or create attributes on the object itself.
Created in NX11.0.0.
License requirements : routing_base ("Routing Basic")
values | NXOpen::Routing::CharacteristicList having the titles, types and values of Attributes to be set |
Implements NXOpen::Routing::ICharacteristic.
void NXOpen::Routing::Stock::SetCrossSection | ( | NXOpen::Routing::CrossSection * | crossSection | ) |
Sets the NXOpen::Routing::CrossSection .
The given object must be one of the NXOpen::Routing::CrossSection objects referenced by the NXOpen::Routing::StockData object that defines this NXOpen::Routing::Stock object. NXOpen::Routing::Stock::SetStockStyle should be used (when possible) instead of this routine.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
crossSection | Must be referenced by the NXOpen::Routing::StockData associated with this NXOpen::Routing::Stock object. |
void NXOpen::Routing::Stock::SetFlippedStatus | ( | NXOpen::Routing::Flip | flipped | ) |
Sets whether or not the profile is flipped.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
flipped | flipped |
void NXOpen::Routing::Stock::SetNegateOffsetsFlag | ( | bool | offsetFlag | ) |
Sets the negate offsets flag of this NXOpen::Routing::Stock .
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
offsetFlag | offset flag |
void NXOpen::Routing::Stock::SetProfileEnd | ( | NXOpen::Routing::ProfileFrom | profileEnd | ) |
Sets the end that defines profile.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
profileEnd | profile end |
void NXOpen::Routing::Stock::SetRotationAngle | ( | double | rotationAngle | ) |
Sets the rotation angle applied to the profile.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
rotationAngle | The angle in radians. Valid values are 0.0 to ( 2 * Pi ). |
void NXOpen::Routing::Stock::SetStockData | ( | NXOpen::Routing::StockData * | stockData | ) |
Sets the NXOpen::Routing::StockData .
After setting the StockData, the caller must also make sure to set the CrossSection and Anchor so that the NXOpen::Routing::Stock object only references objects associated with this NXOpen::Routing::StockData object.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
stockData | stock data |
void NXOpen::Routing::Stock::SetStockStyle | ( | NXOpen::Routing::StockStyle | style | ) |
Sets the NXOpen::Routing::StockStyle of the NXOpen::Routing::Stock .
This may cause update to fire, and can be a time-consuming operation as it may require the building of a new sweep feature. When style is set to NXOpen::Routing::StockStyleNone this routine deletes the stock sweep feature. Only call on Legacy Stocks.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
style | style |
void NXOpen::Routing::Stock::SetTwistAngle | ( | double | twistAngle | ) |
Sets the twist angle applied to the profile.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
twistAngle | The angle in radians. Valid values are 0.0 to ( 2 * Pi ). |
void NXOpen::Routing::Stock::SyncComponentAttrs | ( | bool | isNewPart | ) |
Set the characteristics of the given stock's component so that it has the same characteristics as the NXOpen::Routing::Stock and its stock data.
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
isNewPart | Is the part new? |