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

The Routing OffsetPath object is the set of information needed to define an offset route. More...

Inheritance diagram for NXOpen::Routing::OffsetPath:
NXOpen::NXObject NXOpen::Routing::IPath NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Public Member Functions

virtual void AddSegmentsToList (const std::vector< NXOpen::Routing::ISegment * > &objs)
 Adds segment(s) to an IPath object. More...
 
double BendRadius ()
 Returns the bend radius for an offset object. More...
 
double BendRatio ()
 Returns the bend ratio for an offset object. More...
 
virtual
NXOpen::Routing::ControlPoint
ControlPointEnd ()
 Returns the end ControlPoint for an IPath object. More...
 
virtual
NXOpen::Routing::ControlPoint
ControlPointStart ()
 Returns the start ControlPoint for an IPath object. More...
 
bool CopyCornerFlag ()
 Returns the copy corner flag for an offset object. More...
 
virtual void DelSegmentsFromList (const std::vector< NXOpen::Routing::ISegment * > &objs)
 Removes segment(s) from the IPath object. More...
 
NXOpen::Routing::IPathGetMasterPath ()
 The master path object for this offset object. More...
 
std::vector
< NXOpen::Routing::IPath * > 
GetOffsetPaths ()
 Returns the list of all of the offset paths for a master path. More...
 
std::vector
< NXOpen::Routing::ISegment * > 
GetOffsetPathSegments ()
 The path segments for an offset object. More...
 
void GetOffsetReferenceAxes (NXOpen::Point3d *orgin, NXOpen::Vector3d *xVector, NXOpen::Vector3d *yVector)
 The reference axes for an offset object. More...
 
virtual std::vector
< NXOpen::Routing::ISegment * > 
GetSegmentList ()
 Returns the list of all of the segments contained in the IPath. More...
 
bool IsMaster ()
 Returns the isMaster state for this offset object. More...
 
bool IsSlave ()
 Returns the isSlave state for this offset object. More...
 
bool MaintainStockFlag ()
 Returns the use maintain stock flag for an offset object. More...
 
NXOpen::Vector3d OffsetVector ()
 Returns the vector for an offset object. More...
 
void RemovePathAssociativityFromParent ()
 Breaks the associativity of a child ( slave ) path to its parent ( master ) path. More...
 
void RemovePathAssociativityToImmediateChildren ()
 Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths. More...
 
void SetBendRadius (double radius)
 Sets the bend radius for an offset object. More...
 
void SetBendRatio (double ratio)
 Sets the bend ratio for an offset object. More...
 
virtual void SetControlPointEnd (NXOpen::Routing::ControlPoint *end)
 Sets the end ControlPoint for an IPath object. More...
 
virtual void SetControlPointStart (NXOpen::Routing::ControlPoint *start)
 Sets the start ControlPoint for an IPath object. More...
 
void SetCopyCornerFlag (bool copyCorner)
 Sets the copy corner flag for an offset object. More...
 
void SetMaintainStockFlag (bool maintainStock)
 Sets the use maintain stock flag for an offset object. More...
 
void SetMaster (bool masterState)
 Sets the isMaster state for this offset object. More...
 
void SetMasterPath (NXOpen::Routing::IPath *masterPath)
 The master path object for this offset object. More...
 
void SetOffsetPathSegments (const std::vector< NXOpen::Routing::ISegment * > &segments)
 The path segments for an offset object. More...
 
void SetOffsetReferenceAxes (const NXOpen::Point3d &orgin, const NXOpen::Vector3d &xVector, const NXOpen::Vector3d &yVector)
 The reference axes for an offset object. More...
 
void SetOffsetVector (const NXOpen::Vector3d &vector)
 Sets the vector for an offset object. More...
 
void SetSlave (bool masterState)
 Sets the isSlave state for this offset object. More...
 
void SetUseBendRatio (bool ratioState)
 Sets the use bend ratio flag for an offset object. More...
 
bool UseBendRatio ()
 Returns the use bend ratio flag for an offset object. More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 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::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
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< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (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::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...
 

Detailed Description

The Routing OffsetPath object is the set of information needed to define an offset route.


To obtain an instance of this class use NXOpen::Routing::OffsetPathCollection

Created in NX4.0.0.

Member Function Documentation

virtual void NXOpen::Routing::OffsetPath::AddSegmentsToList ( const std::vector< NXOpen::Routing::ISegment * > &  objs)
virtual

Adds segment(s) to an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
objslist of segments that are to be added

Implements NXOpen::Routing::IPath.

double NXOpen::Routing::OffsetPath::BendRadius ( )

Returns the bend radius for an offset object.


Created in NX4.0.0.

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

double NXOpen::Routing::OffsetPath::BendRatio ( )

Returns the bend ratio for an offset object.


Created in NX4.0.0.

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

virtual NXOpen::Routing::ControlPoint* NXOpen::Routing::OffsetPath::ControlPointEnd ( )
virtual

Returns the end ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IPath.

virtual NXOpen::Routing::ControlPoint* NXOpen::Routing::OffsetPath::ControlPointStart ( )
virtual

Returns the start ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IPath.

bool NXOpen::Routing::OffsetPath::CopyCornerFlag ( )

Returns the copy corner flag for an offset object.


Created in NX4.0.0.

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

virtual void NXOpen::Routing::OffsetPath::DelSegmentsFromList ( const std::vector< NXOpen::Routing::ISegment * > &  objs)
virtual

Removes segment(s) from the IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
objslist of segments that are to be deleted

Implements NXOpen::Routing::IPath.

NXOpen::Routing::IPath* NXOpen::Routing::OffsetPath::GetMasterPath ( )

The master path object for this offset object.

Returns
master path for this offset object
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
std::vector<NXOpen::Routing::IPath *> NXOpen::Routing::OffsetPath::GetOffsetPaths ( )

Returns the list of all of the offset paths for a master path.

Returns
list of all of the offset paths in this master object
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
std::vector<NXOpen::Routing::ISegment *> NXOpen::Routing::OffsetPath::GetOffsetPathSegments ( )

The path segments for an offset object.

Returns
segment list for the offset object
Created in NX4.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
void NXOpen::Routing::OffsetPath::GetOffsetReferenceAxes ( NXOpen::Point3d orgin,
NXOpen::Vector3d xVector,
NXOpen::Vector3d yVector 
)

The reference axes for an offset object.


Created in NX4.0.0.

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

Parameters
orginorigin for the offset object
xVectorX reference axes for the offset object
yVectorY reference axes for the offset object
virtual std::vector<NXOpen::Routing::ISegment *> NXOpen::Routing::OffsetPath::GetSegmentList ( )
virtual

Returns the list of all of the segments contained in the IPath.

Returns
list of all of the segments in this IPath object
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::IPath.

bool NXOpen::Routing::OffsetPath::IsMaster ( )

Returns the isMaster state for this offset object.


Created in NX4.0.0.

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

bool NXOpen::Routing::OffsetPath::IsSlave ( )

Returns the isSlave state for this offset object.


Created in NX4.0.0.

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

bool NXOpen::Routing::OffsetPath::MaintainStockFlag ( )

Returns the use maintain stock flag for an offset object.


Created in NX4.0.0.

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

NXOpen::Vector3d NXOpen::Routing::OffsetPath::OffsetVector ( )

Returns the vector for an offset object.


Created in NX4.0.0.

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

void NXOpen::Routing::OffsetPath::RemovePathAssociativityFromParent ( )

Breaks the associativity of a child ( slave ) path to its parent ( master ) path.


Created in NX5.0.0.

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

void NXOpen::Routing::OffsetPath::RemovePathAssociativityToImmediateChildren ( )

Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths.


Created in NX5.0.0.

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

void NXOpen::Routing::OffsetPath::SetBendRadius ( double  radius)

Sets the bend radius for an offset object.


Created in NX4.0.0.

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

Parameters
radiusradius
void NXOpen::Routing::OffsetPath::SetBendRatio ( double  ratio)

Sets the bend ratio for an offset object.


Created in NX4.0.0.

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

Parameters
ratioratio
virtual void NXOpen::Routing::OffsetPath::SetControlPointEnd ( NXOpen::Routing::ControlPoint end)
virtual

Sets the end ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
endend ControlPoint for the IPath object

Implements NXOpen::Routing::IPath.

virtual void NXOpen::Routing::OffsetPath::SetControlPointStart ( NXOpen::Routing::ControlPoint start)
virtual

Sets the start ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
startstart ControlPoint for the IPath object

Implements NXOpen::Routing::IPath.

void NXOpen::Routing::OffsetPath::SetCopyCornerFlag ( bool  copyCorner)

Sets the copy corner flag for an offset object.


Created in NX4.0.0.

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

Parameters
copyCornercopy corner
void NXOpen::Routing::OffsetPath::SetMaintainStockFlag ( bool  maintainStock)

Sets the use maintain stock flag for an offset object.


Created in NX4.0.0.

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

Parameters
maintainStockmaintain stock
void NXOpen::Routing::OffsetPath::SetMaster ( bool  masterState)

Sets the isMaster state for this offset object.


Created in NX4.0.0.

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

Parameters
masterStatethe state of the offset path object
void NXOpen::Routing::OffsetPath::SetMasterPath ( NXOpen::Routing::IPath masterPath)

The master path object for this offset object.


Created in NX4.0.0.

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

Parameters
masterPathmaster path for this offset object
void NXOpen::Routing::OffsetPath::SetOffsetPathSegments ( const std::vector< NXOpen::Routing::ISegment * > &  segments)

The path segments for an offset object.


Created in NX4.0.0.

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

Parameters
segmentssegment list for the offset object
void NXOpen::Routing::OffsetPath::SetOffsetReferenceAxes ( const NXOpen::Point3d orgin,
const NXOpen::Vector3d xVector,
const NXOpen::Vector3d yVector 
)

The reference axes for an offset object.


Created in NX4.0.0.

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

Parameters
orginorigin for the offset object
xVectorX reference axes for the offset object
yVectorY reference axes for the offset object
void NXOpen::Routing::OffsetPath::SetOffsetVector ( const NXOpen::Vector3d vector)

Sets the vector for an offset object.


Created in NX4.0.0.

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

Parameters
vectorvector for the offset object
void NXOpen::Routing::OffsetPath::SetSlave ( bool  masterState)

Sets the isSlave state for this offset object.


Created in NX4.0.0.

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

Parameters
masterStatethe state of the offset path object
void NXOpen::Routing::OffsetPath::SetUseBendRatio ( bool  ratioState)

Sets the use bend ratio flag for an offset object.


Created in NX4.0.0.

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

Parameters
ratioStateratio state
bool NXOpen::Routing::OffsetPath::UseBendRatio ( )

Returns the use bend ratio flag for an offset object.


Created in NX4.0.0.

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


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