NXOpen::CAE::SetManager Class Reference

Represents a group of CAE object sets. More...

Inheritance diagram for NXOpen::CAE::SetManager:

Public Member Functions
void	CleanTargetSet (int setIndex)
	Clears the objects stored in the set specified in the set manager.
NXOpen::CAE::CAESet *	CreateCaeSet ()
	Creates a CAE.CAESet.
void	GetTargetSetExcludedMembers (int setIndex, std::vector< NXOpen::CAE::SetObject > &objects)
	Gets the objects for the specified target set excluded set.
NXOpen::CAE::CaeGroup *	GetTargetSetGroup (int setIndex)
	Gets the CAE group in the specified set.
void	GetTargetSetMembers (int setIndex, NXOpen::NXObject **displayCoordinateSystem, std::vector< NXOpen::CAE::SetObject > &objects)
	Gets the objects for the specified target set.
void	SetTargetSetEdgePath (int setIndex, const std::vector< NXOpen::CAE::CAEEdge * > &seedEdges, const std::vector< NXOpen::CAE::CAEVertex * > &seedVertices)
	Sets the CAE edge path in the specified set.
void	SetTargetSetElemEdgePath (int setIndex, const std::vector< NXOpen::CAE::FEElemEdge * > &seedEdges, const std::vector< NXOpen::CAE::FENode * > &seedVertices)
	Sets the CAE element edge path in the specified set.
void	SetTargetSetExcludedMembers (int setIndex, const std::vector< NXOpen::CAE::SetObject > &excludedObjects)
	Sets the CAE objects in the specified target set exclude set.
void	SetTargetSetGroup (int setIndex, NXOpen::CAE::CaeSetGroupFilterType filterType, NXOpen::CAE::CaeGroup *group)
	Sets the CAE group in the specified set.
void	SetTargetSetMembers (int setIndex, const std::vector< NXOpen::CAE::SetObject > &objects)
	Sets the CAE objects in the specified set.
int	TargetSetCount ()
	Returns the count of objects in the set Created in NX4.0.0.
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.

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

Represents a group of CAE object sets.

The objects in each set can be used to create loads, constraints ..etc

This is a sub object

Created in NX4.0.0.

Member Function Documentation

void NXOpen::CAE::SetManager::CleanTargetSet

(

int

setIndex

)

Clears the objects stored in the set specified in the set manager.

Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex

index of the set in the set manager

NXOpen::CAE::CAESet* NXOpen::CAE::SetManager::CreateCaeSet

(

)

Creates a CAE.CAESet.

Returns

the cae set created
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::SetManager::GetTargetSetExcludedMembers	(	int	setIndex,
		std::vector< NXOpen::CAE::SetObject > &	objects
	)

Gets the objects for the specified target set excluded set.

Created in NX5.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
objects	objects in set

NXOpen::CAE::CaeGroup* NXOpen::CAE::SetManager::GetTargetSetGroup

(

int

setIndex

)

Gets the CAE group in the specified set.

     @return  group object from set. may be NULL 

Created in NX8.0.1.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex

index of the set

void NXOpen::CAE::SetManager::GetTargetSetMembers	(	int	setIndex,
		NXOpen::NXObject **	displayCoordinateSystem,
		std::vector< NXOpen::CAE::SetObject > &	objects
	)

Gets the objects for the specified target set.

Created in NX4.0.1.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
displayCoordinateSystem	display coordinate system
objects	objects in set

void NXOpen::CAE::SetManager::SetTargetSetEdgePath	(	int	setIndex,
		const std::vector< NXOpen::CAE::CAEEdge * > &	seedEdges,
		const std::vector< NXOpen::CAE::CAEVertex * > &	seedVertices
	)

Sets the CAE edge path in the specified set.

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
seedEdges	seed edges to define the path
seedVertices	seed vertices to define the path

void NXOpen::CAE::SetManager::SetTargetSetElemEdgePath	(	int	setIndex,
		const std::vector< NXOpen::CAE::FEElemEdge * > &	seedEdges,
		const std::vector< NXOpen::CAE::FENode * > &	seedVertices
	)

Sets the CAE element edge path in the specified set.

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
seedEdges	seed element edges to define the path
seedVertices	seed nodes to define the path

void NXOpen::CAE::SetManager::SetTargetSetExcludedMembers	(	int	setIndex,
		const std::vector< NXOpen::CAE::SetObject > &	excludedObjects
	)

Sets the CAE objects in the specified target set exclude set.

Created in NX5.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
excludedObjects	excluded objects to add to set

void NXOpen::CAE::SetManager::SetTargetSetGroup	(	int	setIndex,
		NXOpen::CAE::CaeSetGroupFilterType	filterType,
		NXOpen::CAE::CaeGroup *	group
	)

Sets the CAE group in the specified set.

Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
filterType	filter to extract type of objects from the group
group	group to add to set

void NXOpen::CAE::SetManager::SetTargetSetMembers	(	int	setIndex,
		const std::vector< NXOpen::CAE::SetObject > &	objects
	)

Sets the CAE objects in the specified set.

Created in NX4.0.1.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

setIndex	index of the set
objects	objects to add to set

int NXOpen::CAE::SetManager::TargetSetCount

(

)

Returns the count of objects in the set
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

---

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

• CAE_SetManager.hxx