The Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments. More...

Inheritance diagram for NXOpen::Routing::Stock:

Public Member Functions
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.

Public Member Functions inherited from NXOpen::NXObject
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.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
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.

Public Member Functions inherited from NXOpen::Routing::ICharacteristic
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
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

The Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments.

The material is defined in the Routing::StockData object. Routing::Stock consists of a Routing::StockData object, as well as references to at most one of the Routing::CrossSection and Routing::Anchor objects that are associated with that Routing::StockData .

A 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.

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 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 Routing::StockStyleDetailed style (if availble, otherwise it uses the Routing::StockStyleDetailed style) and the stocks style cannot be changed.

Creator not available in KF because transient objects are not supported.

Created in NX4.0.0.

Member Function Documentation

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 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")

Parameters

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")

Parameters

vector Rotation vector.

void NXOpen::Routing::Stock::ColorBodies ( )

Colors the solid bodies of the stock based on the COLOR characteristic specified in the 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 void NXOpen::Routing::Stock::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

values values

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Stock::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.

       Features can then be applied to each individual sweep by suppressing the unite features.  
       This will help features to survive stock splitting and merging as this ensures that no sweep feature is deleted during a merge.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::Anchor* NXOpen::Routing::Stock::GetAnchor ( )

Gets the Routing::Anchor that currently modifies the profile for the stock.

Returns: Returns NULL if this object isn't using an Routing::Anchor
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::Stock::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.

NXOpen::Assemblies::Component* NXOpen::Routing::Stock::GetComponent ( )

Returns the 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 .

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::CrossSection* NXOpen::Routing::Stock::GetCrossSection ( )

Gets the Routing::CrossSection that currently defines the profile for the stock.

Returns: Returns NULL if this object is using stock style Routing::StockStyleNone
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::Stock::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
         <ul>
             <li>Ports: Reads characteristics from the port.</li>
             <li>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.</li>
             <li>Segments: Reads characteristics from the stock associated with the segment.</li>
             <li>Components: Reads characteristics directly from the component.</li>
             <li>Stock: Reads characteristics from the stock or from the stock's data.</li>
         </ul>
    @return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

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 seperate part file. For Legacy Stock the features exist in the same part as the input object.

Returns: Sweep features.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::Flip NXOpen::Routing::Stock::GetFlippedStatus ( )

Gets whether or not the profile is flipped.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

virtual int NXOpen::Routing::Stock::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.

int NXOpen::Routing::Stock::GetIntegerCharacteristic ( const char * name )

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.

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

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.

Returns: The original length in units of the original part file.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::Stock::GetPorts	(	NXOpen::Routing::StockPort **	startPort,
		NXOpen::Routing::StockPort **	endPort
	)

Returns the Routing::StockPort at each end of the stock.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

virtual double NXOpen::Routing::Stock::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.

double NXOpen::Routing::Stock::GetRealCharacteristic ( const char * name )

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.

double NXOpen::Routing::Stock::GetRotationAngle ( )

Gets the rotation angle applied to the profile.

Returns: The angle in radians.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

std::vector<NXOpen::Curve *> NXOpen::Routing::Stock::GetSegments ( )

Gets the segments that the Routing::Stock object is placed on top of.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::StockData* NXOpen::Routing::Stock::GetStockData ( )

Gets the Routing::StockData .

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::StockStyle NXOpen::Routing::Stock::GetStockStyle ( )

Gets the Routing::StockStyle of the Routing::Stock .

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::StockUse NXOpen::Routing::Stock::GetStockUse ( )

Returns the use of the stock.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

virtual NXString NXOpen::Routing::Stock::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.

NXString NXOpen::Routing::Stock::GetStringCharacteristic ( const char * name )

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.

double NXOpen::Routing::Stock::GetTwistAngle ( )

Gets the twist angle applied to the profile.

Returns: The angle in radians.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::Stock::NegateOffsetsFlag ( )

Returns the negate offsets flag of this 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 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")

Parameters

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")

Parameters

partName Part name to be set
NOTE: The full Unicode character set is not supported for this parameter.

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")

Parameters

partName Part name to be set
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Routing::Stock::SetAnchor ( NXOpen::Routing::Anchor * anchor )

Sets the Routing::Anchor .

The given object must be one of the Routing::Anchor objects referenced by the Routing::StockData object that defines this Routing::Stock object.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

anchor Must be referenced by the Routing::StockData associated with this Routing::Stock object.

virtual void NXOpen::Routing::Stock::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.
value	value

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Stock::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.

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.
value	value

virtual void NXOpen::Routing::Stock::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.
value	value

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Stock::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.

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.
value	value

virtual void NXOpen::Routing::Stock::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.

void NXOpen::Routing::Stock::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.

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.

virtual void NXOpen::Routing::Stock::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

values values

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::Stock::SetCrossSection ( NXOpen::Routing::CrossSection * crossSection )

Sets the Routing::CrossSection .

The given object must be one of the Routing::CrossSection objects referenced by the Routing::StockData object that defines this Routing::Stock object. Routing::Stock::SetStockStyle should be used (when possible) instead of this routine.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

crossSection Must be referenced by the Routing::StockData associated with this 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")

Parameters

flipped flipped

void NXOpen::Routing::Stock::SetNegateOffsetsFlag ( bool offsetFlag )

Sets the negate offsets flag of this Routing::Stock .

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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")

Parameters

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")

Parameters

rotationAngle The angle in radians. Valid values are 0.0 to ( 2 * Pi ).

void NXOpen::Routing::Stock::SetStockData ( NXOpen::Routing::StockData * stockData )

Sets the Routing::StockData .

After setting the StockData, the caller must also make sure to set the CrossSection and Anchor so that the Routing::Stock object only references objects associated with this Routing::StockData object.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockData stock data

void NXOpen::Routing::Stock::SetStockStyle ( NXOpen::Routing::StockStyle style )

Sets the Routing::StockStyle of the 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 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")

Parameters

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")

Parameters

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 Routing::Stock and its stock data.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

isNewPart Is the part new?

The documentation for this class was generated from the following file:

Routing_Stock.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation