NXOpen::CAE::CaeDOFSet Class Reference

Represents a dofset class CAE::CaeDOFSet . More...

Inheritance diagram for NXOpen::CAE::CaeDOFSet:

Public Member Functions
void	AddNodes (const std::vector< NXOpen::CAE::FENode * > &nodes, const std::vector< bool > &dof1, const std::vector< bool > &dof2, const std::vector< bool > &dof3, const std::vector< bool > &dof4, const std::vector< bool > &dof5, const std::vector< bool > &dof6)
	Add nodes to the CaeDOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node.
NXOpen::CAE::CaeDOFSetDisplay *	GetDisplay ()
	The BC Display object associated with the BC object.
int	GetLabel ()
	Gets the label of the CaeDOFSet.
std::vector < NXOpen::CAE::FENode * >	GetNodes ()
	Get the nodes in the DOFSet.
std::vector < NXOpen::CAE::FENode * >	GetNodesWithDof (bool dof1, bool dof2, bool dof3, bool dof4, bool dof5, bool dof6)
	Get the nodes with the given dof value in the DOFSet.
void	Information ()
	Display information of this DOFSet Created in NX7.5.0.
void	ModifyNodeDofs (const std::vector< NXOpen::CAE::FENode * > &nodes, const std::vector< bool > &dof1, const std::vector< bool > &dof2, const std::vector< bool > &dof3, const std::vector< bool > &dof4, const std::vector< bool > &dof5, const std::vector< bool > &dof6)
	Modify the dofs of the passed in nodes in the CaeDOFSet.
void	RemoveAllNodes ()
	Remove all nodes from the CaeDOFSet Created in NX7.5.0.
void	RemoveNodes (const std::vector< NXOpen::CAE::FENode * > &nodes)
	Remove nodes from the CaeDOFSet.
void	SetLabel (int label)
	Sets the label of the CaeDOFSet Created in NX7.5.0.
Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object.
int	Color ()
	Returns the color of the object.
void	Highlight ()
	Highlights the object.
bool	IsBlanked ()
	Returns the blank status of this object.
int	Layer ()
	Returns the layer that the object is in.
NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object.
NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object.
NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name.
void	RedisplayObject ()
	Redisplays the object in all views.
void	SetColor (int color)
	Sets the color of the object.
void	SetLayer (int layer)
	Sets the layer that the object is in.
void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object.
void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object.
void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name.
void	Unblank ()
	Unblanks the object.
void	Unhighlight ()
	Unhighlights the object.
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::DisplayableObject
enum	ObjectFont {   ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline,   ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	specifies the object font for objects such as lines Created in NX3.0.0. More...
enum	ObjectWidth {   ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5,   ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive,   ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	specifies object width for objects such as lines and text Created in NX3.0.0. More...

Detailed Description

Represents a dofset class CAE::CaeDOFSet .

To obtain an instance of this object use on of the creator in CAE::CaeDOFSetCollection .

Created in NX7.5.0.

Member Function Documentation

void NXOpen::CAE::CaeDOFSet::AddNodes	(	const std::vector< NXOpen::CAE::FENode * > &	nodes,
		const std::vector< bool > &	dof1,
		const std::vector< bool > &	dof2,
		const std::vector< bool > &	dof3,
		const std::vector< bool > &	dof4,
		const std::vector< bool > &	dof5,
		const std::vector< bool > &	dof6
	)

Add nodes to the CaeDOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node.

   A false would mean that the dof is not included for that node. 

Created in NX7.5.0.

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

Parameters

nodes	Array of nodes to Add CAE::FENode
dof1	Array of DOF1 values
dof2	Array of DOF2 values
dof3	Array of DOF3 values
dof4	Array of DOF4 values
dof5	Array of DOF5 values
dof6	Array of DOF6 values

NXOpen::CAE::CaeDOFSetDisplay* NXOpen::CAE::CaeDOFSet::GetDisplay

(

)

The BC Display object associated with the BC object.

Returns

Created in NX7.5.0.

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

int NXOpen::CAE::CaeDOFSet::GetLabel

(

)

Gets the label of the CaeDOFSet.

Returns

Label of the DOFSet
Created in NX7.5.0.

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

std::vector<NXOpen::CAE::FENode *> NXOpen::CAE::CaeDOFSet::GetNodes

(

)

Get the nodes in the DOFSet.

Returns

Array of nodes in the DOFSet CAE::FENode
Created in NX7.5.0.

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

std::vector<NXOpen::CAE::FENode *> NXOpen::CAE::CaeDOFSet::GetNodesWithDof	(	bool	dof1,
		bool	dof2,
		bool	dof3,
		bool	dof4,
		bool	dof5,
		bool	dof6
	)

Get the nodes with the given dof value in the DOFSet.

Returns

Array of nodes CAE::FENode in the DOFSet with the dof value
Created in NX7.5.0.

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

Parameters

dof1	DOF1 value
dof2	DOF2 value
dof3	DOF3 value
dof4	DOF4 value
dof5	DOF5 value
dof6	DOF6 value

void NXOpen::CAE::CaeDOFSet::Information

(

)

Display information of this DOFSet
Created in NX7.5.0.

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

void NXOpen::CAE::CaeDOFSet::ModifyNodeDofs	(	const std::vector< NXOpen::CAE::FENode * > &	nodes,
		const std::vector< bool > &	dof1,
		const std::vector< bool > &	dof2,
		const std::vector< bool > &	dof3,
		const std::vector< bool > &	dof4,
		const std::vector< bool > &	dof5,
		const std::vector< bool > &	dof6
	)

Modify the dofs of the passed in nodes in the CaeDOFSet.

   A true for a dof logical entry would mean that the dof is included for that corresponding node.
   A false would mean that the dof is not included for that node. 

Created in NX7.5.0.

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

Parameters

nodes	Array of nodes to modify the dofs CAE::FENode
dof1	Array of DOF1 values
dof2	Array of DOF2 values
dof3	Array of DOF3 values
dof4	Array of DOF4 values
dof5	Array of DOF5 values
dof6	Array of DOF6 values

void NXOpen::CAE::CaeDOFSet::RemoveAllNodes

(

)

Remove all nodes from the CaeDOFSet
Created in NX7.5.0.

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

void NXOpen::CAE::CaeDOFSet::RemoveNodes

(

const std::vector< NXOpen::CAE::FENode * > &

nodes

)

Remove nodes from the CaeDOFSet.

   If the passed in nodes are not there in the DOF Set, the call does nothing. 

Created in NX7.5.0.

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

Parameters

nodes

Array of nodes to Remove CAE::FENode

void NXOpen::CAE::CaeDOFSet::SetLabel

(

int

label

)

Sets the label of the CaeDOFSet
Created in NX7.5.0.

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

Parameters

label

Label of the DOFSet

---

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

• CAE_CaeDOFSet.hxx