JA interface for the UserDefinedObject object
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::UserDefinedObjects::UserDefinedObject:

Classes
struct	LinkDefinition
	Contains the linked object and it's status along with the type of link. More...

Public Types
enum	LinkStatus { LinkStatusUpToDate, LinkStatusOutOfDate }
	Status of the object linked to a UserDefinedObject. More...

enum	LinkType { LinkTypeOwning, LinkTypeType1, LinkTypeType2, LinkTypeType3, LinkTypeType4 }
	Available link types for a UserDefinedObject . More...

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

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
NXString	ClassName ()
	Returns the class name of this UDO Created in NX5.0.0.

void	ClearUserDefinedObjectStatus ()
	Clears the out of data indicator (status) of this UDO Created in NX5.0.0.

std::vector< double >	GetAreas ()
	Gets all of the areas stored with this UDO.

std::vector< double >	GetAreas (int offset, int length)
	Gets the areas stored in the specified range with this UDO.

std::vector< double >	GetDoubles ()
	Gets all of the doubles stored with this UDO.

std::vector< double >	GetDoubles (int offset, int length)
	Gets the doubles stored in the specified range with this UDO.

std::vector< int >	GetIntegers ()
	Gets all of the integers stored with this UDO.

std::vector< int >	GetIntegers (int offset, int length)
	Gets the integers stored in the specified range with this UDO.

std::vector< double >	GetLengths ()
	Gets all of the lengths stored with this UDO.

std::vector< double >	GetLengths (int offset, int length)
	Gets the lengths stored in the specified range with this UDO.

std::vector < NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition >	GetLinks (NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType)
	Gets all links with the given link type that are stored with this UDO.

std::vector < NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition >	GetLinks (NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType, int offset, int length)
	Gets the links with the given link type that are stored in the specified range with this UDO.

std::vector< NXString >	GetStrings ()
	Gets all of the strings stored with this UDO.

std::vector< NXString >	GetStrings (int offset, int length)
	Gets the strings stored in the specified range with this UDO.

NXOpen::Features::UserDefinedObjectFeature *	GetUserDefinedObjectFeature ()
	Gets the Features::UserDefinedObjectFeature associated with this UDO, if there isn't an associated feature, NULL is returned.

int	GetUserDefinedObjectStatus ()
	Gets the out of date indicator (status) of this UDO.

std::vector< double >	GetVolumes ()
	Gets all of the volumes stored with this UDO.

std::vector< double >	GetVolumes (int offset, int length)
	Gets the volumes stored in the specified range with this UDO.

std::vector< double >	PopAreas (int numAreas)
	Removes the areas stored at the end of the area array for this UDO, and returns them in an array.

std::vector< double >	PopDoubles (int numDoubles)
	Removes the doubles stored at the end of the double array for this UDO, and returns them in an array.

std::vector< int >	PopIntegers (int numIntegers)
	Removes the integers stored at the end of the integer array for this UDO, and returns them in an array.

std::vector< double >	PopLengths (int numLengths)
	Removes the lengths stored at the end of the length array for this UDO, and returns them in an array.

std::vector < NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition >	PopLinks (NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType, int numLinks)
	Removes the links stored at the end of the given link type's link array for this UDO, and returns them in an array.

std::vector< NXString >	PopStrings (int numStrings)
	Removes the strings stored at the end of the string array for this UDO, and returns them in an array.

std::vector< double >	PopVolumes (int numVolumes)
	Removes the volumes stored at the end of the volume array for this UDO, and returns them in an array.

void	PushAreas (const std::vector< double > &areas)
	Add the specified areas to the end of the area array for this UDO Created in NX5.0.0.

void	PushDoubles (const std::vector< double > &doubles)
	Add the specified doubles to the end of the double array for this UDO Created in NX5.0.0.

void	PushIntegers (const std::vector< int > &integers)
	Add the specified integers to the end of the integer array for this UDO Created in NX5.0.0.

void	PushLengths (const std::vector< double > &lengths)
	Add the specified lengths to the end of the length array for this UDO Created in NX5.0.0.

void	PushLinks (NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType, const std::vector< NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition > &links)
	Add the specified links to the end of the given link type's link array for this UDO Created in NX5.0.0.

void	PushStrings (std::vector< NXString > &strings)
	Add the specified strings to the end of the string array for this UDO Created in NX5.0.0.

void	PushVolumes (const std::vector< double > &volumes)
	Add the specified volumes to the end of the volume array for this UDO Created in NX5.0.0.

void	SetAreas (const std::vector< double > &areas)
	Sets all of the areas stored with this UDO Created in NX5.0.0.

void	SetAreas (int offset, int length, const std::vector< double > &areas)
	Replaces the areas stored with this UDO in the specified range with a new array of areas Created in NX5.0.0.

void	SetDoubles (const std::vector< double > &doubles)
	Sets all of the doubles stored with this UDO Created in NX5.0.0.

void	SetDoubles (int offset, int length, const std::vector< double > &doubles)
	Replaces the doubles stored with this UDO in the specified range with a new array of doubles Created in NX5.0.0.

void	SetIntegers (const std::vector< int > &integers)
	Sets all of the integers stored with this UDO Created in NX5.0.0.

void	SetIntegers (int offset, int length, const std::vector< int > &integers)
	Replaces the integers stored with this UDO in the specified range with a new array of integers Created in NX5.0.0.

void	SetLengths (const std::vector< double > &lengths)
	Sets all of the lengths stored with this UDO Created in NX5.0.0.

void	SetLengths (int offset, int length, const std::vector< double > &lengths)
	Replaces the lengths stored with this UDO in the specified range with a new array of lengths Created in NX5.0.0.

void	SetLinks (NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType, const std::vector< NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition > &links)
	Sets all of the links with the given link type stored with this UDO.

void	SetLinks (NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType, int offset, int length, const std::vector< NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition > &links)
	Replaces the links of the given link type stored with this UDO in the specified range with a new array of links Created in NX5.0.0.

void	SetStrings (std::vector< NXString > &strings)
	Sets all of the strings stored with this UDO Created in NX5.0.0.

void	SetStrings (int offset, int length, std::vector< NXString > &strings)
	Replaces the strings stored with this UDO in the specified range with a new array of strings Created in NX5.0.0.

void	SetUserDefinedClass (NXOpen::UserDefinedObjects::UserDefinedClass *userDefinedClass)
	Sets the UserDefinedObjects::UserDefinedClass for this UDO Created in NX5.0.0.

void	SetVolumes (const std::vector< double > &volumes)
	Sets all of the volumes stored with this UDO Created in NX5.0.0.

void	SetVolumes (int offset, int length, const std::vector< double > &volumes)
	Replaces the volumes stored with this UDO in the specified range with a new array of volumes Created in NX5.0.0.

NXOpen::UserDefinedObjects::UserDefinedClass *	UserDefinedClass ()
	Returns the UserDefinedObjects::UserDefinedClass for this UDO Created in NX5.0.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.

Detailed Description

JA interface for the UserDefinedObject object
Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::UserDefinedObjects::UserDefinedObject::LinkStatus

Status of the object linked to a UserDefinedObject.

Enumerator:

LinkStatusUpToDate	The associated object is up to date.
LinkStatusOutOfDate	The associated object is out of date.

enum NXOpen::UserDefinedObjects::UserDefinedObject::LinkType

Available link types for a UserDefinedObject .

Enumerator:

LinkTypeOwning	The object is owned by the UDO.
LinkTypeType1	If the UDO is deleted the link between the UDO and the associated object is removed and the object is unaffected. If the UDO is updated the associated object is unaffected. If the associated object is deleted the UDO is also deleted. If the associated object is updated the UDO is updated.
LinkTypeType2	If the UDO is deleted the link between the UDO and the associated object is removed and the object is deleted. If the UDO is updated the associated NX object is unaffected. If the associated object is deleted, it is left in the data model in a condemned state and remains attached to the UDO. If the associated object is updated the UDO is unaffected.
LinkTypeType3	If the UDO is deleted the link between the UDO and the associated object is removed and the object is unaffected. If the UDO is updated the associated object is unaffected. If the associated object is deleted the link to the UDO is removed and the UDO is updated. If the associated object is updated the UDO is updated
LinkTypeType4	If the UDO is deleted the link between the UDO and the associated object is removed and the object is unaffected. If the UDO is updated the associated object is unaffected. If the associated object is deleted the link to the UDO is removed and the UDO is unaffected. If the associated object is updated the UDO is unaffected.

Member Function Documentation

NXString NXOpen::UserDefinedObjects::UserDefinedObject::ClassName ( )

Returns the class name of this UDO
Created in NX5.0.0.

License requirements : None

void NXOpen::UserDefinedObjects::UserDefinedObject::ClearUserDefinedObjectStatus ( )

Clears the out of data indicator (status) of this UDO
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetAreas ( )

Gets all of the areas stored with this UDO.

Returns: Array of areas stored with this UDO
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetAreas	(	int	offset,
		int	length
	)

Gets the areas stored in the specified range with this UDO.

Returns: Array of areas stored within the specified range of the area array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of areas at the start of the returned range. Valid values are 0 through (number of areas in the udo - 1) and -(number of areas in the udo) through -1. If the offset is negative, it is used to count back from the end of the area array. Therefore using -1 or (number of areas in the udo -1) for the offset will give the same result.
length	The number of areas you wish to get

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetDoubles ( )

Gets all of the doubles stored with this UDO.

Returns: Array of doubles stored with this UDO
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetDoubles	(	int	offset,
		int	length
	)

Gets the doubles stored in the specified range with this UDO.

Returns: Array of doubles stored within the specified range of the double array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of doubles at the start of the returned range. Valid values are 0 through (number of doubles in the udo - 1) and -(number of doubles in the udo) through -1. If the offset is negative, it is used to count back from the end of the double array. Therefore using -1 or (number of doubles in the udo -1) for the offset will give the same result.
length	The number of doubles you wish to get

std::vector<int> NXOpen::UserDefinedObjects::UserDefinedObject::GetIntegers ( )

Gets all of the integers stored with this UDO.

Returns: Array of integers stored with this UDO
Created in NX5.0.0.

License requirements : None

std::vector<int> NXOpen::UserDefinedObjects::UserDefinedObject::GetIntegers	(	int	offset,
		int	length
	)

Gets the integers stored in the specified range with this UDO.

Returns: Array of integers stored within the specified range of the integer array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of integers at the start of the returned range. Valid values are 0 through (number of integers in the udo - 1) and -(number of integers in the udo) through -1. If the offset is negative, it is used to count back from the end of the integer array. Therefore using -1 or (number of integers in the udo -1) for the offset will give the same result.
length	The number of integers you wish to get

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetLengths ( )

Gets all of the lengths stored with this UDO.

Returns: Array of lengths stored with this UDO
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetLengths	(	int	offset,
		int	length
	)

Gets the lengths stored in the specified range with this UDO.

Returns: Array of lengths stored within the specified range of the length array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of lengths at the start of the returned range. Valid values are 0 through (number of lengths in the udo - 1) and -(number of lengths in the udo) through -1. If the offset is negative, it is used to count back from the end of the length array. Therefore using -1 or (number of lengths in the udo -1) for the offset will give the same result.
length	The number of lengths you wish to get

std::vector<NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition> NXOpen::UserDefinedObjects::UserDefinedObject::GetLinks ( NXOpen::UserDefinedObjects::UserDefinedObject::LinkType linkType )

Gets all links with the given link type that are stored with this UDO.

Returns: Array of links (with the given link type) stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

linkType The type of links you wish to get

std::vector<NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition> NXOpen::UserDefinedObjects::UserDefinedObject::GetLinks	(	NXOpen::UserDefinedObjects::UserDefinedObject::LinkType	linkType,
		int	offset,
		int	length
	)

Gets the links with the given link type that are stored in the specified range with this UDO.

Returns: Array of links stored within the specified range of the link type's link array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

linkType	The type of links you wish to get
offset	Index into the array of links (with the given link type) at the start of the returned range. Valid values are 0 through (number of links of the given type in the udo - 1) and -(number of links of the given type in the udo) through -1. If the offset is negative, it is used to count back from the end of the link array. Therefore using -1 or (number of links of the given link type in the udo -1) for the offset will give the same result.
length	The number of links (with the given link type) you wish to get

std::vector<NXString> NXOpen::UserDefinedObjects::UserDefinedObject::GetStrings ( )

Gets all of the strings stored with this UDO.

Returns: Array of strings stored with this UDO
Created in NX5.0.0.

License requirements : None

std::vector<NXString> NXOpen::UserDefinedObjects::UserDefinedObject::GetStrings	(	int	offset,
		int	length
	)

Gets the strings stored in the specified range with this UDO.

Returns: Array of strings stored within the specified range of the string array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of strings at the start of the returned range. Valid values are 0 through (number of strings in the udo - 1) and -(number of strings in the udo) through -1. If the offset is negative, it is used to count back from the end of the string array. Therefore using -1 or (number of strings in the udo -1) for the offset will give the same result.
length	The number of strings you wish to get

NXOpen::Features::UserDefinedObjectFeature* NXOpen::UserDefinedObjects::UserDefinedObject::GetUserDefinedObjectFeature ( )

Gets the Features::UserDefinedObjectFeature associated with this UDO, if there isn't an associated feature, NULL is returned.

Returns: The UserDefinedObjectFeature associated this UDO
Created in NX5.0.0.

License requirements : None

int NXOpen::UserDefinedObjects::UserDefinedObject::GetUserDefinedObjectStatus ( )

Gets the out of date indicator (status) of this UDO.

Returns: The status of this UDO 0 - The UDO is up to date 1 - Out of date due to addition or deletion of links to the UDO 2 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method 3 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method 4 - Out of date due to deletion of associated (linked) objects in the absence of a UDO method 5 - Out of date due to addition or deletion of links to the UDO AND deletion of associated (linked) objects in the absence of a UDO method 6 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method 7 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetVolumes ( )

Gets all of the volumes stored with this UDO.

Returns: Array of volumes stored with this UDO
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::GetVolumes	(	int	offset,
		int	length
	)

Gets the volumes stored in the specified range with this UDO.

Returns: Array of volumes stored within the specified range of the volume array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of volumes at the start of the returned range. Valid values are 0 through (number of volumes in the udo - 1) and -(number of volumes in the udo) through -1. If the offset is negative, it is used to count back from the end of the volume array. Therefore using -1 or (number of volumes in the udo -1) for the offset will give the same result.
length	The number of volumes you wish to get

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::PopAreas ( int numAreas )

Removes the areas stored at the end of the area array for this UDO, and returns them in an array.

Returns: Array of areas that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

numAreas num areas

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::PopDoubles ( int numDoubles )

Removes the doubles stored at the end of the double array for this UDO, and returns them in an array.

Returns: Array of doubles that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

numDoubles num doubles

std::vector<int> NXOpen::UserDefinedObjects::UserDefinedObject::PopIntegers ( int numIntegers )

Removes the integers stored at the end of the integer array for this UDO, and returns them in an array.

Returns: Array of integers that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

numIntegers num integers

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::PopLengths ( int numLengths )

Removes the lengths stored at the end of the length array for this UDO, and returns them in an array.

Returns: Array of lengths that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

numLengths num lengths

std::vector<NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition> NXOpen::UserDefinedObjects::UserDefinedObject::PopLinks	(	NXOpen::UserDefinedObjects::UserDefinedObject::LinkType	linkType,
		int	numLinks
	)

Removes the links stored at the end of the given link type's link array for this UDO, and returns them in an array.

Returns: Array of links (with the given link type) that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

linkType	The type of links you wish to remove
numLinks	num links

std::vector<NXString> NXOpen::UserDefinedObjects::UserDefinedObject::PopStrings ( int numStrings )

Removes the strings stored at the end of the string array for this UDO, and returns them in an array.

Returns: Array of strings that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

numStrings num strings

std::vector<double> NXOpen::UserDefinedObjects::UserDefinedObject::PopVolumes ( int numVolumes )

Removes the volumes stored at the end of the volume array for this UDO, and returns them in an array.

Returns: Array of volumes that have been removed from this UDO
Created in NX5.0.0.

License requirements : None

Parameters

numVolumes num volumes

void NXOpen::UserDefinedObjects::UserDefinedObject::PushAreas ( const std::vector< double > & areas )

Add the specified areas to the end of the area array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

areas Array of new areas to add to this UDO. This routine is cumulutive, and will not remove any areas already stored with the UDO. It simply adds these new areas to the end of the existing area array and increases the total number of areas stored with the UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::PushDoubles ( const std::vector< double > & doubles )

Add the specified doubles to the end of the double array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

doubles Array of new doubles to add to this UDO. This routine is cumulutive, and will not remove any doubles already stored with the UDO. It simply adds these new doubles to the end of the existing double array and increases the total number of doubles stored with the UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::PushIntegers ( const std::vector< int > & integers )

Add the specified integers to the end of the integer array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

integers Array of new integers to add to this UDO. This routine is cumulutive, and will not remove any integers already stored with the UDO. It simply adds these new integers to the end of the existing integer array and increases the total number of integers stored with the UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::PushLengths ( const std::vector< double > & lengths )

Add the specified lengths to the end of the length array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

lengths Array of new lengths to add to this UDO. This routine is cumulutive, and will not remove any lengths already stored with the UDO. It simply adds these new lengths to the end of the existing length array and increases the total number of lengths stored with the UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::PushLinks	(	NXOpen::UserDefinedObjects::UserDefinedObject::LinkType	linkType,
		const std::vector< NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition > &	links
	)

Add the specified links to the end of the given link type's link array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

linkType	The type of links you wish to add
links	Array of new links (with the given link type) to add to this UDO. This routine is cumulutive, and will not remove any links already stored with the UDO. It simply adds these new links to the end of the existing link array for the given link type and increases the total number of links of the given type stored with the UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::PushStrings ( std::vector< NXString > & strings )

Add the specified strings to the end of the string array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

strings Array of new strings to add to this UDO. This routine is cumulutive, and will not remove any strings already stored with the UDO. It simply adds these new strings to the end of the existing string array and increases the total number of strings stored with the UDO
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UserDefinedObjects::UserDefinedObject::PushVolumes ( const std::vector< double > & volumes )

Add the specified volumes to the end of the volume array for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

volumes Array of new volumes to add to this UDO. This routine is cumulutive, and will not remove any volumes already stored with the UDO. It simply adds these new volumes to the end of the existing volume array and increases the total number of volumes stored with the UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetAreas ( const std::vector< double > & areas )

Sets all of the areas stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

areas New Array of areas stored with this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetAreas	(	int	offset,
		int	length,
		const std::vector< double > &	areas
	)

Replaces the areas stored with this UDO in the specified range with a new array of areas
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of areas at the start of the range you wish to cut and replace. Valid values are 0 through (number of areas in the udo - 1) and -(number of areas in the udo) through -1. If the offset is negative, it is used to count back from the end of the area array. Therefore using -1 or (number of areas in the udo -1) for the offset will give the same result.
length	The number of areas in the range you wish to cut
areas	Array of areas to paste in place of the specified range.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetDoubles ( const std::vector< double > & doubles )

Sets all of the doubles stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

doubles New Array of doubles stored with this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetDoubles	(	int	offset,
		int	length,
		const std::vector< double > &	doubles
	)

Replaces the doubles stored with this UDO in the specified range with a new array of doubles
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of doubles at the start of the range you wish to cut and replace. Valid values are 0 through (number of doubles in the udo - 1) and -(number of doubles in the udo) through -1. If the offset is negative, it is used to count back from the end of the double array. Therefore using -1 or (number of doubles in the udo -1) for the offset will give the same result.
length	The number of doubles in the range you wish to cut
doubles	Array of doubles to paste in place of the specified range.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetIntegers ( const std::vector< int > & integers )

Sets all of the integers stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

integers New Array of integers stored with this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetIntegers	(	int	offset,
		int	length,
		const std::vector< int > &	integers
	)

Replaces the integers stored with this UDO in the specified range with a new array of integers
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of integers at the start of the range you wish to cut and replace. Valid values are 0 through (number of integers in the udo - 1) and -(number of integers in the udo) through -1. If the offset is negative, it is used to count back from the end of the integer array. Therefore using -1 or (number of integers in the udo -1) for the offset will give the same result.
length	The number of integers in the range you wish to cut
integers	Array of integers to paste in place of the specified range.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetLengths ( const std::vector< double > & lengths )

Sets all of the lengths stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

lengths New Array of lengths stored with this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetLengths	(	int	offset,
		int	length,
		const std::vector< double > &	lengths
	)

Replaces the lengths stored with this UDO in the specified range with a new array of lengths
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of lengths at the start of the range you wish to cut and replace. Valid values are 0 through (number of lengths in the udo - 1) and -(number of lengths in the udo) through -1. If the offset is negative, it is used to count back from the end of the length array. Therefore using -1 or (number of lengths in the udo -1) for the offset will give the same result.
length	The number of lengths in the range you wish to cut
lengths	Array of lengths to paste in place of the specified range.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetLinks	(	NXOpen::UserDefinedObjects::UserDefinedObject::LinkType	linkType,
		const std::vector< NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition > &	links
	)

Sets all of the links with the given link type stored with this UDO.

       If you already had objects linked to the UDO via the specified link type,
       this operation will over-write them with the newly specified links.

Created in NX5.0.0.

License requirements : None

Parameters

linkType	The type of links you wish to set
links	New Array of links (with the given link type) stored with this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetLinks	(	NXOpen::UserDefinedObjects::UserDefinedObject::LinkType	linkType,
		int	offset,
		int	length,
		const std::vector< NXOpen::UserDefinedObjects::UserDefinedObject::LinkDefinition > &	links
	)

Replaces the links of the given link type stored with this UDO in the specified range with a new array of links
Created in NX5.0.0.

License requirements : None

Parameters

linkType	The type of links you wish to set
offset	Index into the array of links (with the given link type) at the start of the range you wish to cut and replace. Valid values are 0 through (number of links with the given link type in the udo - 1) and -(number of links with the given link type in the udo) through -1. If the offset is negative, it is used to count back from the end of the link array. Therefore using -1 or (number of links with the given link type in the udo -1) for the offset will give the same result.
length	The number of links (with the given link type) in the range you wish to cut
links	Array of links (with the given link type) to paste in place of the specified range.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetStrings ( std::vector< NXString > & strings )

Sets all of the strings stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

strings New Array of strings stored with this UDO
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetStrings	(	int	offset,
		int	length,
		std::vector< NXString > &	strings
	)

Replaces the strings stored with this UDO in the specified range with a new array of strings
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of strings at the start of the range you wish to cut and replace. Valid values are 0 through (number of strings in the udo - 1) and -(number of strings in the udo) through -1. If the offset is negative, it is used to count back from the end of the string array. Therefore using -1 or (number of strings in the udo -1) for the offset will give the same result.
length	The number of strings in the range you wish to cut
strings	Array of strings to paste in place of the specified range. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UserDefinedObjects::UserDefinedObject::SetUserDefinedClass ( NXOpen::UserDefinedObjects::UserDefinedClass * userDefinedClass )

Sets the UserDefinedObjects::UserDefinedClass for this UDO
Created in NX5.0.0.

License requirements : None

Parameters

userDefinedClass The new class for this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetVolumes ( const std::vector< double > & volumes )

Sets all of the volumes stored with this UDO
Created in NX5.0.0.

License requirements : None

Parameters

volumes New Array of volumes stored with this UDO

void NXOpen::UserDefinedObjects::UserDefinedObject::SetVolumes	(	int	offset,
		int	length,
		const std::vector< double > &	volumes
	)

Replaces the volumes stored with this UDO in the specified range with a new array of volumes
Created in NX5.0.0.

License requirements : None

Parameters

offset	Index into the array of volumes at the start of the range you wish to cut and replace. Valid values are 0 through (number of volumes in the udo - 1) and -(number of volumes in the udo) through -1. If the offset is negative, it is used to count back from the end of the volume array. Therefore using -1 or (number of volumes in the udo -1) for the offset will give the same result.
length	The number of volumes in the range you wish to cut
volumes	Array of volumes to paste in place of the specified range.

NXOpen::UserDefinedObjects::UserDefinedClass* NXOpen::UserDefinedObjects::UserDefinedObject::UserDefinedClass ( )

Returns the UserDefinedObjects::UserDefinedClass for this UDO
Created in NX5.0.0.

License requirements : None

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

UserDefinedObjects_UserDefinedObject.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation