public interface UserDefinedObject extends DisplayableObject
Modifier and Type | Interface and Description |
---|---|
static class |
UserDefinedObject.LinkDefinition
Contains the linked object and it's status along with the type of link.
|
static class |
UserDefinedObject.LinkStatus
Status of the object linked to a
UserDefinedObjectFeature |
static class |
UserDefinedObject.LinkType
Available link types for a
UserDefinedObjectFeature . |
DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
String |
className()
Returns the class name of this UDO
License requirements: None. |
void |
clearUserDefinedObjectStatus()
Clears the out of data indicator (status) of this UDO
License requirements: None. |
double[] |
getAreas()
Gets all of the areas stored with this UDO
License requirements: None. |
double[] |
getAreas(int offset,
int length)
Gets the areas stored in the specified range with this UDO
License requirements: None. |
double[] |
getDoubles()
Gets all of the doubles stored with this UDO
License requirements: None. |
double[] |
getDoubles(int offset,
int length)
Gets the doubles stored in the specified range with this UDO
License requirements: None. |
int[] |
getIntegers()
Gets all of the integers stored with this UDO
License requirements: None. |
int[] |
getIntegers(int offset,
int length)
Gets the integers stored in the specified range with this UDO
License requirements: None. |
double[] |
getLengths()
Gets all of the lengths stored with this UDO
License requirements: None. |
double[] |
getLengths(int offset,
int length)
Gets the lengths stored in the specified range with this UDO
License requirements: None. |
UserDefinedObject.LinkDefinition[] |
getLinks(UserDefinedObject.LinkType linkType)
Gets all links with the given link type that are stored with this UDO
License requirements: None. |
UserDefinedObject.LinkDefinition[] |
getLinks(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
License requirements: None. |
String[] |
getStrings()
Gets all of the strings stored with this UDO
License requirements: None. |
String[] |
getStrings(int offset,
int length)
Gets the strings stored in the specified range with this UDO
License requirements: None. |
UserDefinedObjectFeature |
getUserDefinedObjectFeature()
Gets the
UserDefinedObjectFeature associated with this UDO, if there isn't an associated feature, null is returned
License requirements: None. |
int |
getUserDefinedObjectStatus()
Gets the out of date indicator (status) of this UDO
License requirements: None. |
double[] |
getVolumes()
Gets all of the volumes stored with this UDO
License requirements: None. |
double[] |
getVolumes(int offset,
int length)
Gets the volumes stored in the specified range with this UDO
License requirements: None. |
double[] |
popAreas(int numAreas)
Removes the areas stored at the end of the area array for this UDO,
and returns them in an array
License requirements: None. |
double[] |
popDoubles(int numDoubles)
Removes the doubles stored at the end of the double array for this UDO,
and returns them in an array
License requirements: None. |
int[] |
popIntegers(int numIntegers)
Removes the integers stored at the end of the integer array for this UDO,
and returns them in an array
License requirements: None. |
double[] |
popLengths(int numLengths)
Removes the lengths stored at the end of the length array for this UDO,
and returns them in an array
License requirements: None. |
UserDefinedObject.LinkDefinition[] |
popLinks(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
License requirements: None. |
String[] |
popStrings(int numStrings)
Removes the strings stored at the end of the string array for this UDO,
and returns them in an array
License requirements: None. |
double[] |
popVolumes(int numVolumes)
Removes the volumes stored at the end of the volume array for this UDO,
and returns them in an array
License requirements: None. |
void |
pushAreas(double[] areas)
Add the specified areas to the end of the area array for this UDO
License requirements: None. |
void |
pushDoubles(double[] doubles)
Add the specified doubles to the end of the double array for this UDO
License requirements: None. |
void |
pushIntegers(int[] integers)
Add the specified integers to the end of the integer array for this UDO
License requirements: None. |
void |
pushLengths(double[] lengths)
Add the specified lengths to the end of the length array for this UDO
License requirements: None. |
void |
pushLinks(UserDefinedObject.LinkType linkType,
UserDefinedObject.LinkDefinition[] links)
Add the specified links to the end of the given link type's link array for this UDO
License requirements: None. |
void |
pushStrings(String[] strings)
Add the specified strings to the end of the string array for this UDO
License requirements: None. |
void |
pushVolumes(double[] volumes)
Add the specified volumes to the end of the volume array for this UDO
License requirements: None. |
void |
setAreas(double[] areas)
Sets all of the areas stored with this UDO
License requirements: None. |
void |
setAreas(int offset,
int length,
double[] areas)
Replaces the areas stored with this UDO in the specified range with a new array of areas
License requirements: None. |
void |
setDoubles(double[] doubles)
Sets all of the doubles stored with this UDO
License requirements: None. |
void |
setDoubles(int offset,
int length,
double[] doubles)
Replaces the doubles stored with this UDO in the specified range with a new array of doubles
License requirements: None. |
void |
setIntegers(int[] integers)
Sets all of the integers stored with this UDO
License requirements: None. |
void |
setIntegers(int offset,
int length,
int[] integers)
Replaces the integers stored with this UDO in the specified range with a new array of integers
License requirements: None. |
void |
setLengths(double[] lengths)
Sets all of the lengths stored with this UDO
License requirements: None. |
void |
setLengths(int offset,
int length,
double[] lengths)
Replaces the lengths stored with this UDO in the specified range with a new array of lengths
License requirements: None. |
void |
setLinks(UserDefinedObject.LinkType linkType,
int offset,
int length,
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
License requirements: None. |
void |
setLinks(UserDefinedObject.LinkType linkType,
UserDefinedObject.LinkDefinition[] links)
Sets all of the links with the given link type stored with this UDO.
|
void |
setStrings(int offset,
int length,
String[] strings)
Replaces the strings stored with this UDO in the specified range with a new array of strings
License requirements: None. |
void |
setStrings(String[] strings)
Sets all of the strings stored with this UDO
License requirements: None. |
void |
setUserDefinedClass(UserDefinedClass userDefinedClass)
License requirements: None. |
void |
setVolumes(double[] volumes)
Sets all of the volumes stored with this UDO
License requirements: None. |
void |
setVolumes(int offset,
int length,
double[] volumes)
Replaces the volumes stored with this UDO in the specified range with a new array of volumes
License requirements: None. |
UserDefinedClass |
userDefinedClass()
Returns the
UserDefinedClass for this UDO
License requirements: None. |
blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
String className() throws NXException, RemoteException
NXException
RemoteException
int getUserDefinedObjectStatus() throws NXException, RemoteException
NXException
RemoteException
void clearUserDefinedObjectStatus() throws NXException, RemoteException
NXException
RemoteException
UserDefinedClass userDefinedClass() throws NXException, RemoteException
NXException
RemoteException
void setUserDefinedClass(UserDefinedClass userDefinedClass) throws NXException, RemoteException
userDefinedClass
- The new class for this UDONXException
RemoteException
UserDefinedObjectFeature getUserDefinedObjectFeature() throws NXException, RemoteException
UserDefinedObjectFeature
associated with this UDO, if there isn't an associated feature, null is returned
NXException
RemoteException
int[] getIntegers() throws NXException, RemoteException
NXException
RemoteException
int[] getIntegers(int offset, int length) throws NXException, RemoteException
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 getNXException
RemoteException
void setIntegers(int[] integers) throws NXException, RemoteException
integers
- New Array of integers stored with this UDONXException
RemoteException
void setIntegers(int offset, int length, int[] integers) throws NXException, RemoteException
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 cutintegers
- Array of integers to paste in place of the specified range.NXException
RemoteException
int[] popIntegers(int numIntegers) throws NXException, RemoteException
numIntegers
- NXException
RemoteException
void pushIntegers(int[] integers) throws NXException, RemoteException
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 UDONXException
RemoteException
double[] getDoubles() throws NXException, RemoteException
NXException
RemoteException
double[] getDoubles(int offset, int length) throws NXException, RemoteException
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 getNXException
RemoteException
void setDoubles(double[] doubles) throws NXException, RemoteException
doubles
- New Array of doubles stored with this UDONXException
RemoteException
void setDoubles(int offset, int length, double[] doubles) throws NXException, RemoteException
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 cutdoubles
- Array of doubles to paste in place of the specified range.NXException
RemoteException
double[] popDoubles(int numDoubles) throws NXException, RemoteException
numDoubles
- NXException
RemoteException
void pushDoubles(double[] doubles) throws NXException, RemoteException
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 UDONXException
RemoteException
String[] getStrings() throws NXException, RemoteException
NXException
RemoteException
String[] getStrings(int offset, int length) throws NXException, RemoteException
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 getNXException
RemoteException
void setStrings(String[] strings) throws NXException, RemoteException
strings
- New Array of strings stored with this UDONXException
RemoteException
void setStrings(int offset, int length, String[] strings) throws NXException, RemoteException
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 cutstrings
- Array of strings to paste in place of the specified range.NXException
RemoteException
String[] popStrings(int numStrings) throws NXException, RemoteException
numStrings
- NXException
RemoteException
void pushStrings(String[] strings) throws NXException, RemoteException
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 UDONXException
RemoteException
double[] getLengths() throws NXException, RemoteException
NXException
RemoteException
double[] getLengths(int offset, int length) throws NXException, RemoteException
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 getNXException
RemoteException
void setLengths(double[] lengths) throws NXException, RemoteException
lengths
- New Array of lengths stored with this UDONXException
RemoteException
void setLengths(int offset, int length, double[] lengths) throws NXException, RemoteException
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 cutlengths
- Array of lengths to paste in place of the specified range.NXException
RemoteException
double[] popLengths(int numLengths) throws NXException, RemoteException
numLengths
- NXException
RemoteException
void pushLengths(double[] lengths) throws NXException, RemoteException
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 UDONXException
RemoteException
double[] getAreas() throws NXException, RemoteException
NXException
RemoteException
double[] getAreas(int offset, int length) throws NXException, RemoteException
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 getNXException
RemoteException
void setAreas(double[] areas) throws NXException, RemoteException
areas
- New Array of areas stored with this UDONXException
RemoteException
void setAreas(int offset, int length, double[] areas) throws NXException, RemoteException
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 cutareas
- Array of areas to paste in place of the specified range.NXException
RemoteException
double[] popAreas(int numAreas) throws NXException, RemoteException
numAreas
- NXException
RemoteException
void pushAreas(double[] areas) throws NXException, RemoteException
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 UDONXException
RemoteException
double[] getVolumes() throws NXException, RemoteException
NXException
RemoteException
double[] getVolumes(int offset, int length) throws NXException, RemoteException
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 getNXException
RemoteException
void setVolumes(double[] volumes) throws NXException, RemoteException
volumes
- New Array of volumes stored with this UDONXException
RemoteException
void setVolumes(int offset, int length, double[] volumes) throws NXException, RemoteException
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 cutvolumes
- Array of volumes to paste in place of the specified range.NXException
RemoteException
double[] popVolumes(int numVolumes) throws NXException, RemoteException
numVolumes
- NXException
RemoteException
void pushVolumes(double[] volumes) throws NXException, RemoteException
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 UDONXException
RemoteException
UserDefinedObject.LinkDefinition[] getLinks(UserDefinedObject.LinkType linkType) throws NXException, RemoteException
linkType
- The type of links you wish to getNXException
RemoteException
UserDefinedObject.LinkDefinition[] getLinks(UserDefinedObject.LinkType linkType, int offset, int length) throws NXException, RemoteException
linkType
- The type of links you wish to getoffset
- 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 getNXException
RemoteException
void setLinks(UserDefinedObject.LinkType linkType, UserDefinedObject.LinkDefinition[] links) throws NXException, RemoteException
linkType
- The type of links you wish to setlinks
- New Array of links (with the given link type) stored with this UDONXException
RemoteException
void setLinks(UserDefinedObject.LinkType linkType, int offset, int length, UserDefinedObject.LinkDefinition[] links) throws NXException, RemoteException
linkType
- The type of links you wish to setoffset
- 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 cutlinks
- Array of links (with the given link type) to paste in place of the specified range.NXException
RemoteException
UserDefinedObject.LinkDefinition[] popLinks(UserDefinedObject.LinkType linkType, int numLinks) throws NXException, RemoteException
linkType
- The type of links you wish to removenumLinks
- NXException
RemoteException
void pushLinks(UserDefinedObject.LinkType linkType, UserDefinedObject.LinkDefinition[] links) throws NXException, RemoteException
linkType
- The type of links you wish to addlinks
- 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 UDONXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.