NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Positioning::ComponentNetwork Class Reference

Network for use in positioning components in NX. More...

Inheritance diagram for NXOpen::Positioning::ComponentNetwork:
NXOpen::Positioning::Network NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

Public Types

enum  ArrangementsMode { ArrangementsModeExisting, ArrangementsModeInUsed }
 Specifies how changes in the network are applied to arrangements. More...
 
- Public Types inherited from NXOpen::Positioning::Network
enum  ObjectStatus {
  ObjectStatusUnknown, ObjectStatusFixed, ObjectStatusOverDefined, ObjectStatusNotConsistentDims,
  ObjectStatusNotConsistentOther, ObjectStatusNotConsistentUnknown, ObjectStatusNotChanged, ObjectStatusWellDefined,
  ObjectStatusUnderDefined
}
 Specifies the solver status of a movable object. 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

NXOpen::Positioning::ComponentNetwork::ArrangementsMode NetworkArrangementsMode ()
 返回此网络的配置模式. 
 
void SetNetworkArrangementsMode (NXOpen::Positioning::ComponentNetwork::ArrangementsMode mode)
 Sets the arrangements mode for this network.
 
- Public Member Functions inherited from NXOpen::Positioning::Network
void AddConstraint (NXOpen::Positioning::Constraint *constraint)
 Add a Constraint to the network.
 
void AddMovableObject (NXOpen::NXObject *movableObject)
 Add a movable object to the network.
 
void ApplyToModel ()
 Applies the current network state to the model.
 
void BeginDrag ()
 Notify the network that a sequence of drag operations is about to begin.
 
NXOpen::Assemblies::ComponentDisplayComponent ()
 Returns the Assemblies::Component in which the display is changed by solving the network.
 
void DragByRay (const NXOpen::Point3d &point, const NXOpen::Vector3d &direction)
 Move objects which have been added to the network using Positioning::Network::AddMovableObject .
 
void DragByTransform (const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation)
 Move objects which have been added to the network using Positioning::Network::AddMovableObject .
 
void DragByTranslation (const NXOpen::Vector3d &translation)
 Move objects which have been added to the network using Positioning::Network::AddMovableObject .
 
void EmptyMovingGroup ()
 Remove all elements from the moving_group.
 
void EndDrag ()
 Notify the network that a sequence of drag operations has ended.
 
NXOpen::Positioning::Network::ObjectStatus GetMovableObjectStatus (NXOpen::NXObject *movableObject)
 Returns the solver status of a movable object.
 
bool IsReferencedGeometryLoaded ()
 Are the necessary objects loaded so that all connected constraints can be included during a drag or solve ?
 
void LoadReferencedGeometry ()
 Load the necessary objects so that all connected constraints can be included during a drag or solve.
 
bool MoveObjectsState ()
 Returns the move objects state for the network.
 
bool NonMovingGroupGrounded ()
 Returns the grounded state of non-moving_group objects.
 
void RemoveAllConstraints ()
 Remove all Constraint s which have been explcitly added to the network.
 
void RemoveConstraint (NXOpen::Positioning::Constraint *constraint)
 Remove a Constraint from the network.
 
void RemoveMovableObject (NXOpen::NXObject *movableObject)
 Remove a movable object from the network.
 
void ResetDisplay ()
 Returns the display objects to their model positions.
 
void SetDisplayComponent (NXOpen::Assemblies::Component *displayComponent)
 Sets the Assemblies::Component in which the display is changed by solving the network.
 
void SetMoveObjectsState (bool moveObjectsState)
 Sets the move objects state for the network.
 
void SetMovingGroup (const std::vector< NXOpen::NXObject * > &movableObjects)
 Set the elements of the moving_group.
 
void SetNonMovingGroupGrounded (bool ground)
 Sets the grounded state of non-moving_group objects.
 
void Solve ()
 Solves the constraint network.
 
- 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::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
NXOpen::INXObjectFindObject (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< NXStringGetUserAttributesAsStrings ()
 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::BasePartOwningPart ()
 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::INXObjectPrototype ()
 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::INXObjectFindObject (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.
 

Detailed Description

Network for use in positioning components in NX.

   A component network extends the @link Positioning::Network Positioning::Network@endlink  by
   adding support for @link Assemblies::Arrangement Assemblies::Arrangement@endlink s.
<br> Use @link Positioning::Positioner::EstablishNetwork Positioning::Positioner::EstablishNetwork@endlink  to create an instance of this class.  <br> 


Created in NX6.0.0.

Member Enumeration Documentation

Specifies how changes in the network are applied to arrangements.

This setting will be ignored when positioning geometry in a piece part.

Enumerator:
ArrangementsModeExisting 

Apply transforms in arrangements according to existing component properties.

Constraints are created non-arrangement specific.

ArrangementsModeInUsed 

Apply transforms in the used arrangement only.

Constraints are created arrangement specific in the used arrangement and suppressed in all other arrangements

Member Function Documentation

NXOpen::Positioning::ComponentNetwork::ArrangementsMode NXOpen::Positioning::ComponentNetwork::NetworkArrangementsMode ( )

Returns the arrangements mode for this network.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Positioning::ComponentNetwork::SetNetworkArrangementsMode ( NXOpen::Positioning::ComponentNetwork::ArrangementsMode  mode)

Sets the arrangements mode for this network.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
modeThe Positioning::ComponentNetwork::ArrangementsMode .

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