Routing Run object references components and stocks which comprise a piping run. More...

Inheritance diagram for NXOpen::Routing::Run:

Public Types
enum	CompareStatus { CompareStatusNone, CompareStatusOk, CompareStatusMissingRun, CompareStatusExtraRun, CompareStatusMissingItem, CompareStatusExtraItem, CompareStatusDiscrepancy }
	Represents discrepancies in the run compared to another run. More...

enum	FlipStatus { FlipStatusSuccess, FlipStatusNotTwoPorts, FlipStatusUnequalConstraints, FlipStatusPortPositionMismatch, FlipStatusFlowTypeMismatch, FlipStatusFollowsFlow, FlipStatusRunFlowNotDefined, FlipStatusCannotFlip }
	Represents result of flip component. More...

enum	Status { StatusValid, StatusBroken, StatusIncomplete }
	Represents the status of a run. More...

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

Public Member Functions
void	DeleteRunPath ()
	This will delete the Run path and member items in a run Created in NX8.0.0. More...

std::vector< NXOpen::ObjectList * >	DetectRunSpools ()
	This will detect spools in a run. More...

NXOpen::Routing::Run::Status	Edit (const NXString &runId, const NXString &runType, const std::vector< NXOpen::NXObject * > &from, const std::vector< NXOpen::NXObject * > &to, const std::vector< NXOpen::NXObject * > &member)
	Edits an existing run with new items. More...

NXOpen::Routing::Run::Status	Edit (const char runId, const char runType, const std::vector< NXOpen::NXObject * > &from, const std::vector< NXOpen::NXObject * > &to, const std::vector< NXOpen::NXObject * > &member)
	Edits an existing run with new items. More...

void	Edit (const NXString &runId, const NXString &runType, const std::vector< NXOpen::Routing::RunItem * > &fromItems, const std::vector< NXOpen::Routing::RunItem * > &toItems, const std::vector< NXOpen::Routing::RunItem * > &memberItems)
	Edits an existing run with new run item data. More...

void	Edit (const char runId, const char runType, const std::vector< NXOpen::Routing::RunItem * > &fromItems, const std::vector< NXOpen::Routing::RunItem * > &toItems, const std::vector< NXOpen::Routing::RunItem * > &memberItems)
	Edits an existing run with new run item data. More...

NXOpen::Routing::Run::FlipStatus	FlipComponent (NXOpen::Assemblies::Component *component)
	Flips a component that is part of a run by rotating the component so that it's input and output ports reverse. More...

bool	GetActiveStatus ()
	Get status of Run, Active or Inactive. More...

NXOpen::Routing::CharacteristicList *	GetCharacteristics ()
	Get all of the characteristics values on the this object. More...

NXOpen::Routing::CharacteristicList *	GetCharacteristicsWithId ()
	Get all of the characteristics values on the this object, including RunId. More...

std::vector < NXOpen::Routing::RunItem * >	GetFromItemData ()
	Retrieves the data of the "From" items of a run. More...

std::vector< NXOpen::NXObject * >	GetFromItems ()
	Retrieves the from items of a run. More...

std::vector < NXOpen::Routing::RunItem * >	GetMemberItemData ()
	Retrieves the data of the "Member" items of a run. More...

std::vector< NXOpen::NXObject * >	GetMembers ()
	Retrieves the member items of a run. More...

NXOpen::Routing::RoutingSystem *	GetRoutingSystem ()
	Ask the NXOpen::Routing::RoutingSystem run belongs to. More...

NXOpen::Routing::Run::CompareStatus	GetRunCompareStatus ()
	Ask the compare status of run. More...

NXString	GetRunId ()
	Retrieves the run_id of run. More...

NXOpen::Routing::Run::Status	GetRunStatus ()
	Ask the status of run. More...

NXString	GetRunType ()
	Retrieves the run type of run. More...

std::vector < NXOpen::Routing::RunItem * >	GetToItemData ()
	Retrieves the data of the "To" items of a run. More...

std::vector< NXOpen::NXObject * >	GetToItems ()
	Retrieves the to items of a run. More...

void	MakeActive ()
	Set a Run as Active. More...

void	MakeInactive ()
	Set a Run as Inactive and the Active Specification will be changed to Default Specification of the discipline, if no discipline is being used then the Active Specification will be set to None. More...

int	RunSegmentGetFlowDirection (NXOpen::Routing::ISegment *segment)
	Get flow direction of a run segment. More...

void	RunSegmentReverseFlowDirection (NXOpen::Routing::ISegment *segment)
	Reverse flow direction of a run segment Created in NX5.0.0. More...

void	RunSegmentSetFlowDirection (NXOpen::Routing::ISegment *segment, int flowState)
	Set flow direction of a run segment Created in NX5.0.0. More...

void	SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
	Set all of the characteristics values on this object. 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...

Detailed Description

Routing Run object references components and stocks which comprise a piping run.

To create an instance of this class us Routing::RunCollection::CreateRun

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::Run::CompareStatus

Represents discrepancies in the run compared to another run.

Enumerator
CompareStatusNone	Run has no compare status. Compare operation is not invoked yet
CompareStatusOk	No missing, extra or discrepancy items.
CompareStatusMissingRun	Entire run is missing.
CompareStatusExtraRun	Entire run is extra.
CompareStatusMissingItem	Item or items are missing from the run.
CompareStatusExtraItem	Extra item or items present in the run.
CompareStatusDiscrepancy	Items have characteristics discrepancies.

enum NXOpen::Routing::Run::FlipStatus

Represents result of flip component.

Enumerator
FlipStatusSuccess	Component is flipped.
FlipStatusNotTwoPorts	Given component ports are not equal to two ports.
FlipStatusUnequalConstraints	Each ports has different number of constraints.
FlipStatusPortPositionMismatch	Ports are not collinear and opposite or perpendicular.
FlipStatusFlowTypeMismatch	Ports are defined with ambiguous flow types.
FlipStatusFollowsFlow	Ports correctly aligned with flow. No flipping done.
FlipStatusRunFlowNotDefined	Flow is not defined on Run. Component can't be flipped.
FlipStatusCannotFlip	Run is deleted or there are no segments attached to component. Component cannot be flipped.

enum NXOpen::Routing::Run::Status

Represents the status of a run.

Enumerator

StatusValid

Run is valid.

All items are connected and all segments have stocks assigned on them

StatusBroken

Run is broken.

All items are not connected end to end

StatusIncomplete

Run is incomplete.

Some segments do not have stock assigned on them

Member Function Documentation

void NXOpen::Routing::Run::DeleteRunPath ( )

This will delete the Run path and member items in a run
Created in NX8.0.0.

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

std::vector<NXOpen::ObjectList *> NXOpen::Routing::Run::DetectRunSpools ( )

This will detect spools in a run.

Returns: Created in NX5.0.0.

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

NXOpen::Routing::Run::Status NXOpen::Routing::Run::Edit	(	const NXString &	runId,
		const NXString &	runType,
		const std::vector< NXOpen::NXObject * > &	from,
		const std::vector< NXOpen::NXObject * > &	to,
		const std::vector< NXOpen::NXObject * > &	member
	)

Edits an existing run with new items.

NOTE: Removes any existing items in the run and adds these new items

Returns: Valid, broken or incomplete run
Created in NX4.0.0.

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

Parameters

runId	Unique identifier of the Run
runType	Type of the Run
from	Array of to items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
to	Array of to items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
member	Array of member items. Must be NXOpen::Assemblies::Component , NXOpen::Routing::ISegment or Routing.Stock

NXOpen::Routing::Run::Status NXOpen::Routing::Run::Edit	(	const char *	runId,
		const char *	runType,
		const std::vector< NXOpen::NXObject * > &	from,
		const std::vector< NXOpen::NXObject * > &	to,
		const std::vector< NXOpen::NXObject * > &	member
	)

Edits an existing run with new items.

NOTE: Removes any existing items in the run and adds these new items

Returns: Valid, broken or incomplete run
Created in NX4.0.0.

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

Parameters

runId	Unique identifier of the Run
runType	Type of the Run
from	Array of to items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
to	Array of to items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
member	Array of member items. Must be NXOpen::Assemblies::Component , NXOpen::Routing::ISegment or Routing.Stock

void NXOpen::Routing::Run::Edit	(	const NXString &	runId,
		const NXString &	runType,
		const std::vector< NXOpen::Routing::RunItem * > &	fromItems,
		const std::vector< NXOpen::Routing::RunItem * > &	toItems,
		const std::vector< NXOpen::Routing::RunItem * > &	memberItems
	)

Edits an existing run with new run item data.

NOTE: Removes any existing items in the run and adds these new items.
Created in NX7.5.4.

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

Parameters

runId	Unique identifier of the Run
runType	Type of the Run
fromItems	Array of "From" item data.
toItems	Array of "To" item data.
memberItems	Array of "Member" item data.

void NXOpen::Routing::Run::Edit	(	const char *	runId,
		const char *	runType,
		const std::vector< NXOpen::Routing::RunItem * > &	fromItems,
		const std::vector< NXOpen::Routing::RunItem * > &	toItems,
		const std::vector< NXOpen::Routing::RunItem * > &	memberItems
	)

Edits an existing run with new run item data.

NOTE: Removes any existing items in the run and adds these new items.
Created in NX7.5.4.

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

Parameters

runId	Unique identifier of the Run
runType	Type of the Run
fromItems	Array of "From" item data.
toItems	Array of "To" item data.
memberItems	Array of "Member" item data.

NXOpen::Routing::Run::FlipStatus NXOpen::Routing::Run::FlipComponent ( NXOpen::Assemblies::Component * component )

Flips a component that is part of a run by rotating the component so that it's input and output ports reverse.

Returns: Flip Component status
Created in NX8.5.0.

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

Parameters

component component

bool NXOpen::Routing::Run::GetActiveStatus ( )

Get status of Run, Active or Inactive.

Returns: Created in NX8.5.0.

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

NXOpen::Routing::CharacteristicList* NXOpen::Routing::Run::GetCharacteristics ( )

Get all of the characteristics values on the this object.

Returns: Created in NX7.5.4.

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

NXOpen::Routing::CharacteristicList* NXOpen::Routing::Run::GetCharacteristicsWithId ( )

Get all of the characteristics values on the this object, including RunId.

Returns: Created in NX8.5.3.

License requirements : routing_base ("Routing Basic")

std::vector<NXOpen::Routing::RunItem *> NXOpen::Routing::Run::GetFromItemData ( )

Retrieves the data of the "From" items of a run.

Returns: Array of data for the "From" items.
Created in NX7.5.4.

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

std::vector<NXOpen::NXObject *> NXOpen::Routing::Run::GetFromItems ( )

Retrieves the from items of a run.

From items are extracted ports or run

Returns: All from items of the run
Created in NX4.0.0.

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

std::vector<NXOpen::Routing::RunItem *> NXOpen::Routing::Run::GetMemberItemData ( )

Retrieves the data of the "Member" items of a run.

Returns: Array of data for the "Member" items.
Created in NX7.5.4.

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

std::vector<NXOpen::NXObject *> NXOpen::Routing::Run::GetMembers ( )

Retrieves the member items of a run.

Member items are part occurrence of ports, stocks, or segments.

Returns: All member items of the run
Created in NX9.0.0.

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

NXOpen::Routing::RoutingSystem* NXOpen::Routing::Run::GetRoutingSystem ( )

Ask the NXOpen::Routing::RoutingSystem run belongs to.

Returns: RoutingSystem run belongs to
Created in NX4.0.0.

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

NXOpen::Routing::Run::CompareStatus NXOpen::Routing::Run::GetRunCompareStatus ( )

Ask the compare status of run.

Returns: Run compare status
Created in NX4.0.0.

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

NXString NXOpen::Routing::Run::GetRunId ( )

Retrieves the run_id of run.

Returns: Run id of run
Created in NX4.0.0.

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

NXOpen::Routing::Run::Status NXOpen::Routing::Run::GetRunStatus ( )

Ask the status of run.

Returns: Valid, broken or incomplete run
Created in NX4.0.0.

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

NXString NXOpen::Routing::Run::GetRunType ( )

Retrieves the run type of run.

Returns: Run type of run
Created in NX4.0.0.

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

std::vector<NXOpen::Routing::RunItem *> NXOpen::Routing::Run::GetToItemData ( )

Retrieves the data of the "To" items of a run.

Returns: Array of data for the "To" items.
Created in NX7.5.4.

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

std::vector<NXOpen::NXObject *> NXOpen::Routing::Run::GetToItems ( )

Retrieves the to items of a run.

To items are extracted ports or run

Returns: All to items of the run
Created in NX4.0.0.

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

void NXOpen::Routing::Run::MakeActive ( )

Set a Run as Active.

All the newly created segments and parts through Linear Path, Spline Path, Heal Path and parts placed through Place Part will be added as members to the Active Run. The specification of the Run will be set as Active Specification. The previous active run will be made Inactive. Use NXOpen::Routing::Run::MakeInactive to make a Run as Inactive.
Created in NX8.5.0.

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

void NXOpen::Routing::Run::MakeInactive ( )

Set a Run as Inactive and the Active Specification will be changed to Default Specification of the discipline, if no discipline is being used then the Active Specification will be set to None.

Use NXOpen::Routing::Run::MakeActive to make a Run as Active.
Created in NX8.5.0.

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

int NXOpen::Routing::Run::RunSegmentGetFlowDirection ( NXOpen::Routing::ISegment * segment )

Get flow direction of a run segment.

Returns: Created in NX5.0.0.

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

Parameters

segment segment

void NXOpen::Routing::Run::RunSegmentReverseFlowDirection ( NXOpen::Routing::ISegment * segment )

Reverse flow direction of a run segment
Created in NX5.0.0.

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

Parameters

segment segment

void NXOpen::Routing::Run::RunSegmentSetFlowDirection	(	NXOpen::Routing::ISegment *	segment,
		int	flowState
	)

Set flow direction of a run segment
Created in NX5.0.0.

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

Parameters

segment	segment
flowState	flow state

void NXOpen::Routing::Run::SetCharacteristics ( NXOpen::Routing::CharacteristicList * values )

Set all of the characteristics values on this object.

Created in NX7.5.4.

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

Parameters

values values

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

Routing_Run.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation