NX Open C++ Reference Guide
|
Represents an Routing::Overstock object. More...
Public Member Functions | |
std::vector < NXOpen::Routing::Stock * > | GetCoveredStocks () |
Get the stocks covering this Routing::Overstock . | |
NXOpen::Scalar * | GetGapDistance () |
Get the gap distance for this Routing::Overstock . | |
NXOpen::Scalar * | GetNumberOfWraps () |
Returns the number of wraps for this Routing::Overstock . | |
NXOpen::Routing::CreationMethod | GetOverstockCreationMethod () |
Returns the creation method of this Routing::Overstock . | |
std::vector< NXOpen::Curve * > | GetOverstockSegments () |
Returns the segments over which this Routing::Overstock is applied. | |
NXOpen::Routing::Type | GetOverstockType () |
Returns the type of overstock. | |
NXOpen::Scalar * | GetPercentageOverlap () |
Get the overlap percentage of this Routing::Overstock . | |
NXOpen::Scalar * | GetThickness () |
Get the thickness of this Routing::Overstock . | |
NXOpen::Scalar * | GetWidth () |
Get the width of this Routing::Overstock . | |
![]() | |
void | AddSegments (const std::vector< NXOpen::Curve * > &segments) |
Adds new segments to this object. | |
void | AlignStock (const NXOpen::Vector3d &vector) |
Align stock to new rotation vector. | |
void | ColorBodies () |
Colors the solid bodies of the stock based on the COLOR characteristic specified in the Routing::StockData of the stock. | |
virtual void | DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values) |
Removes the input list of characteristics from this object. | |
void | EnableFeatures () |
Makes the stock "featurable" by generating a sweep feature over every segment of the stock, with a boolean feature uniting all of the sweeps to form a single body. | |
NXOpen::Routing::Anchor * | GetAnchor () |
Gets the Routing::Anchor that currently modifies the profile for the stock. | |
virtual NXOpen::Routing::CharacteristicList * | GetCharacteristics () |
Get all of the characteristics values on the this object. | |
NXOpen::Assemblies::Component * | GetComponent () |
Returns the Assemblies::Component created and controlled by the stock for a Stock as Components stock. | |
NXOpen::Routing::CrossSection * | GetCrossSection () |
Gets the Routing::CrossSection that currently defines the profile for the stock. | |
virtual NXOpen::Routing::CharacteristicList * | GetDestinationCharacteristics () |
Returns the destination characteristics from the input object. | |
std::vector < NXOpen::Features::Feature * > | GetFeatures () |
Returns the sweep features that are created and controlled by this object. | |
NXOpen::Routing::Flip | GetFlippedStatus () |
Gets whether or not the profile is flipped. | |
virtual int | GetIntegerCharacteristic (const NXString &name) |
Get the value of an integer characteristic associated with the input name. | |
int | GetIntegerCharacteristic (const char *name) |
Get the value of an integer characteristic associated with the input name. | |
NXOpen::Routing::ComponentName | GetNameStatus () |
Returns whether or not the component associated with a Stock as Components Stock has a permanent or temporary name. | |
double | GetOriginalLength () |
Returns the original length for a stock that has been deformed (it's use is Routing::StockUseDeformed ). | |
void | GetPorts (NXOpen::Routing::StockPort **startPort, NXOpen::Routing::StockPort **endPort) |
Returns the Routing::StockPort at each end of the stock. | |
NXOpen::Routing::ProfileFrom | GetProfileEnd () |
Gets the end that defines profile. | |
virtual double | GetRealCharacteristic (const NXString &name) |
Get the value of a real characteristic associated with the input name. | |
double | GetRealCharacteristic (const char *name) |
Get the value of a real characteristic associated with the input name. | |
double | GetRotationAngle () |
Gets the rotation angle applied to the profile. | |
std::vector< NXOpen::Curve * > | GetSegments () |
Gets the segments that the Routing::Stock object is placed on top of. | |
NXOpen::Routing::StockData * | GetStockData () |
Gets the Routing::StockData . | |
NXOpen::Routing::StockStyle | GetStockStyle () |
Gets the Routing::StockStyle of the Routing::Stock . | |
NXOpen::Routing::StockUse | GetStockUse () |
Returns the use of the stock. | |
virtual NXString | GetStringCharacteristic (const NXString &name) |
Get the value of a string characteristic associated with the input name. | |
NXString | GetStringCharacteristic (const char *name) |
Get the value of a string characteristic associated with the input name. | |
double | GetTwistAngle () |
Gets the twist angle applied to the profile. | |
bool | NegateOffsetsFlag () |
Returns the negate offsets flag of this Routing::Stock . | |
void | RemoveSegments (const std::vector< NXOpen::Curve * > &segments) |
Removes segments from this object. | |
void | RenameStockComponent (const NXString &partName) |
Renames the stock component part with given name Created in NX7.5.4. | |
void | RenameStockComponent (const char *partName) |
Renames the stock component part with given name Created in NX7.5.4. | |
void | SetAnchor (NXOpen::Routing::Anchor *anchor) |
Sets the Routing::Anchor . | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
virtual void | SetCharacteristics (NXOpen::Routing::CharacteristicList *values) |
Set all of the characteristics values on this object. | |
void | SetCrossSection (NXOpen::Routing::CrossSection *crossSection) |
Sets the Routing::CrossSection . | |
void | SetFlippedStatus (NXOpen::Routing::Flip flipped) |
Sets whether or not the profile is flipped. | |
void | SetNegateOffsetsFlag (bool offsetFlag) |
Sets the negate offsets flag of this Routing::Stock . | |
void | SetProfileEnd (NXOpen::Routing::ProfileFrom profileEnd) |
Sets the end that defines profile. | |
void | SetRotationAngle (double rotationAngle) |
Sets the rotation angle applied to the profile. | |
void | SetStockData (NXOpen::Routing::StockData *stockData) |
Sets the Routing::StockData . | |
void | SetStockStyle (NXOpen::Routing::StockStyle style) |
Sets the Routing::StockStyle of the Routing::Stock . | |
void | SetTwistAngle (double twistAngle) |
Sets the twist angle applied to the profile. | |
void | SyncComponentAttrs (bool isNewPart) |
Set the characteristics of the given stock's component so that it has the same characteristics as the Routing::Stock and its stock data. | |
![]() | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type) |
Deletes all attributes of a specific type. | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes all attributes of a specific type with the option to update or not. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title) |
Deletes an attribute by type and title. | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title) |
Deletes an attribute by type and title. | |
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. | |
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. | |
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 and Index. | |
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 and Index. | |
void | DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes the attributes encountered with the given Type with option to update or not. | |
virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type) |
Gets all the attribute titles of a specific type. | |
bool | GetBooleanUserAttribute (const NXString &title, int index) |
Gets a boolean attribute by Title and array Index. | |
bool | GetBooleanUserAttribute (const char *title, int index) |
Gets a boolean attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
int | GetIntegerAttribute (const NXString &title) |
Gets an integer attribute by title. | |
int | GetIntegerAttribute (const char *title) |
Gets an integer attribute by title. | |
int | GetIntegerUserAttribute (const NXString &title, int index) |
Gets an integer attribute by Title and array Index. | |
int | GetIntegerUserAttribute (const char *title, int index) |
Gets an integer attribute by Title and array Index. | |
double | GetRealAttribute (const NXString &title) |
Gets a real attribute by title. | |
double | GetRealAttribute (const char *title) |
Gets a real attribute by title. | |
double | GetRealUserAttribute (const NXString &title, int index) |
Gets a real attribute by Title and array Index. | |
double | GetRealUserAttribute (const char *title, int index) |
Gets a real attribute by Title and array Index. | |
NXString | GetReferenceAttribute (const NXString &title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. | |
NXString | GetReferenceAttribute (const char *title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. | |
NXString | GetStringAttribute (const NXString &title) |
Gets a string attribute value by title. | |
NXString | GetStringAttribute (const char *title) |
Gets a string attribute value by title. | |
NXString | GetStringUserAttribute (const NXString &title, int index) |
Gets a string attribute by Title and array Index. | |
NXString | GetStringUserAttribute (const char *title, int index) |
Gets a string attribute by Title and array Index. | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title) |
Gets a time attribute by title. | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title) |
Gets a time attribute by title. | |
NXString | GetTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. | |
NXString | GetTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. | |
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. | |
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. | |
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. | |
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. | |
bool | GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. | |
bool | GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes () |
Gets all the attributes that have been set on the given object. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset) |
Gets all the attributes that have been set on the given object. | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes that have been set on the given object. | |
std::vector< NXString > | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. | |
std::vector< NXOpen::NXObject * > | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. | |
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). | |
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). | |
virtual bool | IsOccurrence () |
Returns whether this object is an occurrence or not. | |
virtual NXString | JournalIdentifier () |
Returns the identifier that would be recorded in a journal for this object. | |
virtual NXString | Name () |
Returns the custom name of the object. | |
virtual NXOpen::Assemblies::Component * | OwningComponent () |
Returns the owning component, if this object is an occurrence. | |
virtual NXOpen::BasePart * | OwningPart () |
Returns the owning part of this object Created in NX3.0.0. | |
virtual void | Print () |
Prints a representation of this object to the system log file. | |
virtual NXOpen::INXObject * | Prototype () |
Returns the prototype of this object if it is an occurrence. | |
void | SetAttribute (const NXString &title, int value) |
Creates or modifies an integer attribute. | |
void | SetAttribute (const char *title, int value) |
Creates or modifies an integer attribute. | |
void | SetAttribute (const NXString &title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetAttribute (const char *title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. | |
void | SetAttribute (const NXString &title, double value) |
Creates or modifies a real attribute. | |
void | SetAttribute (const char *title, double value) |
Creates or modifies a real attribute. | |
void | SetAttribute (const NXString &title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetAttribute (const char *title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. | |
void | SetAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute. | |
void | SetAttribute (const char *title, const char *value) |
Creates or modifies a string attribute. | |
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. | |
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. | |
void | SetAttribute (const NXString &title) |
Creates or modifies a null attribute which is an attribute with a title and no value. | |
void | SetAttribute (const char *title) |
Creates or modifies a null attribute which is an attribute with a title and no value. | |
void | SetAttribute (const NXString &title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetAttribute (const char *title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
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. | |
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. | |
virtual void | SetName (const NXString &name) |
Sets the custom name of the object. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
void | SetReferenceAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute which uses a reference string. | |
void | SetReferenceAttribute (const char *title, const char *value) |
Creates or modifies a string attribute which uses a reference string. | |
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. | |
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. | |
void | SetTimeAttribute (const NXString &title, const NXString &value) |
Creates or modifies a time attribute. | |
void | SetTimeAttribute (const char *title, const char *value) |
Creates or modifies a time attribute. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
void | SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option) |
Creates or modifies an attribute with the option to update or not. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
void | SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetUserAttribute (const char *title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. | |
void | SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
void | SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
![]() | |
NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXObject with the given identifier as recorded in a journal. | |
void | SetName (const char *name) |
Sets the custom name of the object. | |
![]() | |
int | GetIntegerCharacteristic (const char *name) |
Get the value of an integer characteristic associated with the input name. | |
double | GetRealCharacteristic (const char *name) |
Get the value of a real characteristic associated with the input name. | |
NXString | GetStringCharacteristic (const char *name) |
Get the value of a string characteristic associated with the input name. | |
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. | |
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. | |
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. | |
Additional Inherited Members | |
![]() | |
enum | AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 } |
Specifies attribute type. More... | |
enum | DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual } |
Specifies the format of the date and time attribute. More... | |
Represents an Routing::Overstock object.
Creator not available in KF.
Created in NX5.0.0.
std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::Overstock::GetCoveredStocks | ( | ) |
Get the stocks covering this Routing::Overstock .
NXOpen::Scalar* NXOpen::Routing::Overstock::GetGapDistance | ( | ) |
Get the gap distance for this Routing::Overstock .
NXOpen::Scalar* NXOpen::Routing::Overstock::GetNumberOfWraps | ( | ) |
Returns the number of wraps for this Routing::Overstock .
NXOpen::Routing::CreationMethod NXOpen::Routing::Overstock::GetOverstockCreationMethod | ( | ) |
Returns the creation method of this Routing::Overstock .
std::vector<NXOpen::Curve *> NXOpen::Routing::Overstock::GetOverstockSegments | ( | ) |
Returns the segments over which this Routing::Overstock is applied.
NXOpen::Routing::Type NXOpen::Routing::Overstock::GetOverstockType | ( | ) |
Returns the type of overstock.
Possible types are wrapped, sleeved, flagged and an overstock with fixed cross section.
NXOpen::Scalar* NXOpen::Routing::Overstock::GetPercentageOverlap | ( | ) |
Get the overlap percentage of this Routing::Overstock .
NXOpen::Scalar* NXOpen::Routing::Overstock::GetThickness | ( | ) |
Get the thickness of this Routing::Overstock .
NXOpen::Scalar* NXOpen::Routing::Overstock::GetWidth | ( | ) |
Get the width of this Routing::Overstock .