public interface Component extends DisplayableObject, ICharacteristic
ComponentAssembly
. Note that a
Component is an occurrence whose prototype is a Part
. See
INXObject.prototype()
.
ComponentAssembly.rootComponent()
which has a null
parent. The components below the root are referred to as "Top Level" components, which
represent the component parts that have been added directly to the
ComponentAssembly. (Calling ComponentAssembly.addComponent(java.lang.String, java.lang.String, java.lang.String, nxopen.Point3d, nxopen.Matrix3x3, int)
will
create a new Top Level component.) Components beneath the top level represent
components defined in sub-assemblies of the main assembly.
Modifier and Type | Interface and Description |
---|---|
static class |
Component.FindComponentPatternsData
This class holds the data returned from
findComponentPatterns() |
static class |
Component.PositionData
This class holds the data returned from
getPosition() |
static class |
Component.RealQuantityData
This class holds the data returned from
getRealQuantity() |
static class |
Component.RepresentationMode
Representation status of a component
|
DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
CollaborativeContentType |
collaborativeContentType()
Returns the collaborative content type of this component.
|
InstanceSelectionCriteria |
createEmptyPartFamilyInstanceSelectionCriteria(Template family)
Creates an empty
InstanceSelectionCriteria
License requirements: solid_modeling ("SOLIDS MODELING") Created in NX9.0.0 |
void |
deleteInstanceUserAttribute(NXObject.AttributeType type,
String title,
boolean deleteEntireArray,
Update.Option option)
Deletes the first attribute encountered with the given Type, Title and Index.
|
void |
deleteInstanceUserAttributes(NXObject.AttributeType type,
Update.Option option)
Deletes the attributes encountered with the given Type with option to update or not.
|
void |
deletePartFamilyInstanceSelectionCriteria()
Deletes
InstanceSelectionCriteria associated with this component
License requirements: solid_modeling ("SOLIDS MODELING") Created in NX9.0.0 |
DesignElementRevision |
designElementRevision()
Deprecated.
Deprecated in NX11.0.0. Use
modelElementRevision() instead.
|
DesignSubordinateRevision |
designSubordinateRevision()
Returns the
DesignSubordinateRevision that corresponds to this component. |
ComponentAssembly |
directOwner()
Returns the
ComponentAssembly which owns this component as a "Top Level" component. |
ErrorList |
displayComponentsExact(Component[] components)
Sets an array of components to display using the exact representation.
|
ErrorList |
displayComponentsLightweight(Component[] components)
Sets an array of components to display using the lightweight representation.
|
String |
displayName()
Returns the displayable name of the prototype part.
|
String |
emptyPartRefsetName()
Returns the name of the reference set which represents the empty set.
|
String |
entirePartRefsetName()
Returns the name of the reference set which represents the entire part.
|
void |
establishIsolatedPositionOverride(Component parent,
Arrangement arrangement)
Ensures there is an isolated positioning override for the
Component in the given part of
the given parent. |
void |
establishPositionOverride(Component parent)
Ensures there is a positioning override on component in the given part of
the given parent.
|
Component.FindComponentPatternsData |
findComponentPatterns()
Finds
ComponentPattern associated with this component. |
NXObject |
findOccurrence(NXObject proto)
Given a prototype object, returns the corresponding occurrence
in this component
License requirements: None. |
ComponentConstraint |
fixConstraint()
Returns a fix
ComponentConstraint of this component. |
Arrangement[] |
getArrangements()
Outputs the
Arrangement objects within the Component . |
String |
getAsRequiredQuantity()
Gets the as-required quantity on this component.
|
Component[] |
getChildren()
Returns the child components of this component
However, it does not return non-geometric components (NGCs)
To enable this method to also return NGCs, set the following environment variable:
UGII_ALLOW_NGC_IN_UGOPEN=YES
License requirements: None. |
ComponentQuantity |
getComponentQuantityType()
Gets the quantity type of the components.
|
Component.RepresentationMode |
getComponentRepresentationMode()
Returns the representation mode for the component's bodies.
|
ComponentConstraint[] |
getConstraints()
Returns the
ComponentConstraint s directly connected to this component. |
DegreesOfFreedom |
getDegreesOfFreedom()
Returns the
DegreesOfFreedom for this component. |
DegreesOfFreedom |
getDegreesOfFreedom(Component[] components)
Returns the
DegreesOfFreedom for this component. |
boolean |
getInstanceBooleanUserAttribute(String title,
int index)
Gets a boolean attribute by Title and array Index.
|
int |
getInstanceIntegerUserAttribute(String title,
int index)
Gets an integer attribute by Title and array Index.
|
double |
getInstanceRealUserAttribute(String title,
int index)
Gets a real attribute by Title and array Index.
|
String |
getInstanceStringUserAttribute(String title,
int index)
Gets a string attribute by Title and array Index.
|
String |
getInstanceTimeUserAttribute(String title,
int index)
Gets a time attribute by Title and array Index.
|
NXObject.AttributeInformation |
getInstanceUserAttribute(String title,
NXObject.AttributeType type,
int index)
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
|
String |
getInstanceUserAttributeAsString(String title,
NXObject.AttributeType type,
int index)
Gets the first attribute encountered on the object, if any, with a given title, type and array index.
|
boolean |
getInstanceUserAttributeLock(String title,
NXObject.AttributeType type)
Determine the lock of the given attribute.
|
NXObject.AttributeInformation[] |
getInstanceUserAttributes()
Gets all the attributes that have been set on the given object.
|
NXObject.AttributeInformation[] |
getInstanceUserAttributes(boolean includeUnset)
Gets all the attributes that have been set on the given object,
as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true').
|
String[] |
getInstanceUserAttributesAsStrings()
Gets all the attributes that have been set on the given object.
|
int |
getIntegerQuantity()
Gets the value of the integer quantity of component.
|
int |
getLayerOption()
Gets the layer option.
|
boolean |
getNonGeometricState()
Gets the component state as Geometric or Non-Geometric.
|
InstanceSelectionCriteria |
getPartFamilyInstanceSelectionCriteria()
Obtains the
InstanceSelectionCriteria , if it exists. |
Component.PositionData |
getPosition()
Gets the position of a component
License requirements: assemblies ("ASSEMBLIES MODULE") . |
Component |
getPositionOverrideParent()
Find the highest level parent in which the position of component is
overridden.
|
PositionOverrideType |
getPositionOverrideType()
Gets the type of the highest level positioning override on the component.
|
Component.RealQuantityData |
getRealQuantity()
Gets the value of real quantity and corresponding units on this component.
|
boolean |
hasInstanceUserAttribute(String title,
NXObject.AttributeType type,
int index)
Determines if and 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).
|
boolean |
isFixed()
Returns the fixed state of this component.
|
boolean |
isPositioningIsolated(Arrangement arrangement)
Get whether positioning for the selected
Component is isolated in the specified
Arrangement . |
boolean |
isSuppressed()
Returns
the suppressed state of the component in its controlling arrangement.
|
ModelElementRevision |
modelElementRevision()
Returns the
ModelElementRevision that corresponds to this component. |
Component |
parent()
Returns the parent of the component.
|
ComponentConstraint[] |
recallAndListConstraints()
Recalls the
ComponentConstraint s previously remembered on the part
of this component, creating new constraints from them. |
void |
recallConstraints()
Recalls the
ComponentConstraint s previously remembered on the part
of this component, creating new constraints from them. |
String |
referenceSet()
Returns
the name of the reference set used for this component
License requirements: assemblies ("ASSEMBLIES MODULE") . |
void |
removePositionOverride(Component parent)
Removes the highest level positioning override on component in or below
the given parent.
|
void |
removeRememberedConstraints()
Remove all the remembered constraints stored on the part of this component.
|
void |
setInstanceBooleanUserAttribute(String title,
int index,
boolean value,
Update.Option option)
Creates or modifies a boolean attribute with the option to update or not.
|
void |
setInstanceTimeUserAttribute(String title,
int index,
String value,
Update.Option option)
Creates or modifies a time attribute with the option to update or not.
|
void |
setInstanceUserAttribute(NXObject.AttributeInformation info,
Update.Option option)
Creates or modifies an attribute with the option to update or not.
|
void |
setInstanceUserAttribute(String title,
int index,
double value,
Update.Option option)
Creates or modifies a real attribute with the option to update or not.
|
void |
setInstanceUserAttribute(String title,
int index,
int value,
Update.Option option)
Creates or modifies an integer attribute with the option to update or not.
|
void |
setInstanceUserAttribute(String title,
int index,
String value,
Update.Option option)
Creates or modifies a string attribute with the option to update or not.
|
void |
setInstanceUserAttribute(String title,
int index,
Update.Option option)
Creates or modifies a null attribute with the option to update or not.
|
void |
setInstanceUserAttributeLock(String title,
NXObject.AttributeType type,
boolean lock)
Lock or unlock the given attribute.
|
void |
setLayerOption(int layer)
Sets the layer option.
|
void |
setPartFamilyInstanceSelectionCriteria(InstanceSelectionCriteria selectionCriteria)
Hooks
InstanceSelectionCriteria to this component
License requirements: solid_modeling ("SOLIDS MODELING") Created in NX9.0.0 |
void |
setPositioningIsolated(Arrangement arrangement)
Set positioning for the selected
Component as isolated in the specified
Arrangement . |
void |
setPositioningVaried(Component[] components,
boolean setAsVaried)
Set positioning for the selected
Component s across all possible
Arrangement s. |
void |
setUsedArrangement(Arrangement newArrangement)
Changes the Arrangement used for this component.
|
Subset |
subset()
Returns the
Subset that corresponds to this component. |
void |
suppress()
Suppresses the component in the ComponentAssembly that contains its controlling Arrangement.
|
ErrorList |
suppress(Component[] components)
Suppresses an array of components in the ComponentAssembly that contains their
controlling Arrangement.
|
Arrangement |
suppressingArrangement()
Returns
the
Arrangement that controls this component's
suppression state. |
void |
unsuppress()
Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement.
|
ErrorList |
unsuppress(Component[] components)
Unsuppresses an array of components in the ComponentAssembly that contains their
controlling Arrangement.
|
void |
updateStructure(Component[] components,
int nLevels)
Update the assembly structure for this assembly in the
context of the displayed part to the specified number of
levels, ignoring components already processed by previous
calls.
|
void |
updateStructure(Component[] components,
int nLevels,
boolean checkComponentsVisited)
Update the assembly structure for this assembly in the
context of the displayed part to the specified number of
levels.
|
Arrangement |
usedArrangement()
Returns
the Arrangement used for this component.
|
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
deleteCharacterstics, getCharacteristics, getDestinationCharacteristics, getIntegerCharacteristic, getRealCharacteristic, getStringCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic2, setCharacteristic2, setCharacteristic2, setCharacteristics, setCharacteristics2
Component parent() throws NXException, RemoteException
ComponentAssembly.rootComponent()
.
NXException
RemoteException
ComponentAssembly directOwner() throws NXException, RemoteException
ComponentAssembly
which owns this component as a "Top Level" component.
For components in a multi-level assembly, this is NOT the same the part that owns this component object.
I.e. it is not the same as calling:
NXOpen.NXObject.OwningPart()
NXOpen.BasePart.ComponentAssembly()
NXException
RemoteException
Component[] getChildren() throws NXException, RemoteException
NXException
RemoteException
NXObject findOccurrence(NXObject proto) throws NXException, RemoteException
proto
- the prototypeNXException
RemoteException
int getLayerOption() throws NXException, RemoteException
NXException
RemoteException
void setLayerOption(int layer) throws NXException, RemoteException
layer
- The new layer for this component in its parent part
-1 Means use the original layer settings defined in the component's part.
0 Means use the current work layer
1-255 Means use the specified layer.NXException
RemoteException
String entirePartRefsetName() throws NXException, RemoteException
ComponentAssembly.replaceReferenceSet(nxopen.assemblies.Component, java.lang.String)
.
NXException
RemoteException
String emptyPartRefsetName() throws NXException, RemoteException
ComponentAssembly.replaceReferenceSet(nxopen.assemblies.Component, java.lang.String)
.
NXException
RemoteException
String referenceSet() throws NXException, RemoteException
NXException
RemoteException
Component.PositionData getPosition() throws NXException, RemoteException
NXException
RemoteException
void establishPositionOverride(Component parent) throws NXException, RemoteException
Component
.
parent
- The parent of the component in which the override is to be createdNXException
RemoteException
void establishIsolatedPositionOverride(Component parent, Arrangement arrangement) throws NXException, RemoteException
Component
in the given part of
the given parent. This method does nothing if the Component
already has an isolated
positioning override in the parent, or if any necessary data is unloaded.
If parent is null, the isolated positioning override will be created in the same part as the Component
.
parent
- The parent of the Component
in which the override is to be createdarrangement
- The Arrangement
in which to create the
isolated position override. This Arrangement
must be
an isolated Arrangement
.NXException
RemoteException
void setPositioningIsolated(Arrangement arrangement) throws NXException, RemoteException
Component
as isolated in the specified
Arrangement
.
The arrangement must be an isolated arrangement defined in the same part as the component.
arrangement
- The Arrangement
in which to set
positioning as isolated. This Arrangement
must
be an isolated Arrangement
.NXException
RemoteException
boolean isPositioningIsolated(Arrangement arrangement) throws NXException, RemoteException
Component
is isolated in the specified
Arrangement
.
arrangement
- The specified Arrangement
.Component
is isolated
in the specified Arrangement
.NXException
RemoteException
void removePositionOverride(Component parent) throws NXException, RemoteException
parent
- The parent of the component in or below which the override is to be removedNXException
RemoteException
Component getPositionOverrideParent() throws NXException, RemoteException
NXException
RemoteException
PositionOverrideType getPositionOverrideType() throws NXException, RemoteException
NXException
RemoteException
Arrangement[] getArrangements() throws NXException, RemoteException
Arrangement
objects within the Component
.
They are output in alphabetic order.
NXException
RemoteException
Arrangement suppressingArrangement() throws NXException, RemoteException
Arrangement
that controls this component's
suppression state. The controlling Arrangement will be defined in a
ComponentAssembly
in the tree above this Component.
Arrangement
controlling this component's
suppression state. This will be null if the assembly containing the
arrangement is not loaded.NXException
RemoteException
void setUsedArrangement(Arrangement newArrangement) throws NXException, RemoteException
directOwner()
and
ComponentAssembly.setActiveArrangement(nxopen.assemblies.Arrangement)
.) For
non-root components, this sets the arrangement used for this component in the
context of its parent component. Note that this method should only be used for
components which have children.
newArrangement
- The new Arrangement
. This Arrangement
must be defined in a the ComponentAssembly of this Component's
prototype part.NXException
RemoteException
Arrangement usedArrangement() throws NXException, RemoteException
setUsedArrangement(nxopen.assemblies.Arrangement)
NXException
RemoteException
void setPositioningVaried(Component[] components, boolean setAsVaried) throws NXException, RemoteException
Component
s across all possible
Arrangement
s. Positioning can be set to either the same in all
Arrangement
s, set_as_varied = FALSE, or individually positioned in each,
set_as_varied = TRUE.
components
- The components whose positioning will be altered.setAsVaried
- If FALSE components will have same position in all Arrangement
s, TRUE allows the position to be varied.NXException
RemoteException
boolean isSuppressed() throws NXException, RemoteException
suppressingArrangement()
.)
NXException
RemoteException
void suppress() throws NXException, RemoteException
suppressingArrangement()
Arrangement.owner()
ComponentAssembly.suppressComponents(nxopen.assemblies.Component[], nxopen.assemblies.Arrangement[])
NXException
RemoteException
ErrorList suppress(Component[] components) throws NXException, RemoteException
suppressingArrangement()
Arrangement.owner()
ComponentAssembly.suppressComponents(nxopen.assemblies.Component[], nxopen.assemblies.Arrangement[])
components
- Components to be suppressed. Each component will be
suppressed in its controlling arrangement. Note that
the components must all be underneath the same assemblyNXException
RemoteException
void unsuppress() throws NXException, RemoteException
suppressingArrangement()
Arrangement.owner()
ComponentAssembly.unsuppressComponents(nxopen.assemblies.Component[], nxopen.assemblies.Arrangement[])
NXException
RemoteException
ErrorList unsuppress(Component[] components) throws NXException, RemoteException
suppressingArrangement()
Arrangement.owner()
ComponentAssembly.unsuppressComponents(nxopen.assemblies.Component[], nxopen.assemblies.Arrangement[])
components
- Components to be unsuppressed. Each component will be
unsuppressed in its controlling arrangement. Note that
the components must all be underneath the same assemblyNXException
RemoteException
void updateStructure(Component[] components, int nLevels) throws NXException, RemoteException
components
- Component tags to start update structure fromnLevels
- The number of levels to update. If -1 then all levels are updated.NXException
RemoteException
void updateStructure(Component[] components, int nLevels, boolean checkComponentsVisited) throws NXException, RemoteException
components
- Component tags to start update structure fromnLevels
- The number of levels to update. If -1 then all levels are updated.checkComponentsVisited
- If true, only perform update structure on each component once this session.NXException
RemoteException
String displayName() throws NXException, RemoteException
NXException
RemoteException
boolean isFixed() throws NXException, RemoteException
ComponentConstraint
fix constraint on this component
and false otherwise. If the part controlling the position of this
component is not loaded then false will be returned.
NXException
RemoteException
ComponentConstraint fixConstraint() throws NXException, RemoteException
ComponentConstraint
of this component.
The constraint may be suppressed or null. If the part
controlling the position of this component is not loaded then null
will be returned.
NXException
RemoteException
ComponentConstraint[] getConstraints() throws NXException, RemoteException
ComponentConstraint
s directly connected to this component. If
the part containing those constraints is not loaded then no constraints will be
returned.
NXException
RemoteException
DegreesOfFreedom getDegreesOfFreedom() throws NXException, RemoteException
DegreesOfFreedom
for this component.
Any constraints that reference unloaded data are ignored in the degrees of freedom calculation. An example
would be if a constraint was referencing geometry in an unloaded component. When this occurs there may be
a greater number of degrees of freedom than if all the data were loaded.
NXException
RemoteException
DegreesOfFreedom getDegreesOfFreedom(Component[] components) throws NXException, RemoteException
DegreesOfFreedom
for this component.
The degrees of freedom are found relative to the components passed in.
Those components are regarded as fixed and only constraints directly
connecting this component with those in the array are considered.
Note that any directly connected constraints that reference unloaded data
are ignored in the degrees of freedom calculation. An example would be if
a constraint was referencing geometry in an unloaded component. When this
occurs there may be a greater number of degrees of freedom than if all
the data were loaded.
components
- Components relative to which the degrees
of freedom will be found.NXException
RemoteException
void recallConstraints() throws NXException, RemoteException
ComponentConstraint
s previously remembered on the part
of this component, creating new constraints from them. The new constraints are
incomplete and refer to the component.
NXException
RemoteException
ComponentConstraint[] recallAndListConstraints() throws NXException, RemoteException
ComponentConstraint
s previously remembered on the part
of this component, creating new constraints from them. The new constraints are
incomplete and refer to the component.
NXException
RemoteException
void removeRememberedConstraints() throws NXException, RemoteException
NXException
RemoteException
boolean getNonGeometricState() throws NXException, RemoteException
NXException
RemoteException
ComponentQuantity getComponentQuantityType() throws NXException, RemoteException
ComponentQuantity
.
NXException
RemoteException
int getIntegerQuantity() throws NXException, RemoteException
NXException
RemoteException
Component.RealQuantityData getRealQuantity() throws NXException, RemoteException
NXException
RemoteException
String getAsRequiredQuantity() throws NXException, RemoteException
NXException
RemoteException
ErrorList displayComponentsLightweight(Component[] components) throws NXException, RemoteException
components
- Array of components to be set to lightweightNXException
RemoteException
ErrorList displayComponentsExact(Component[] components) throws NXException, RemoteException
components
- Array of componets to be set to exactNXException
RemoteException
Component.RepresentationMode getComponentRepresentationMode() throws NXException, RemoteException
NXException
RemoteException
void setInstanceUserAttribute(NXObject.AttributeInformation info, Update.Option option) throws NXException, RemoteException
NXObject.AttributeType.REFERENCE
.
Instead, set the type to NXObject.AttributeType.STRING
and specify a ReferenceValue.
The following data members of the Info structure are ignored by this method:
Alias
Inherited
Required
Unset
Locked
The following data members of an attribute cannot be edited once the attribute is set:
Type
Title
TitleAlias
Array
ArrayElementIndex
The dimensionality of the Unit specification (cannot change from mm to microA, but from mm to cm is fine)
The following data members can be set and modified only if the attribute is not associated with a template:
Category
The following data of an attribute can be set if and only if the attribute is not associated with a template. It cannot be modified once set.
Array
info
- option
- NXException
RemoteException
void setInstanceUserAttribute(String title, int index, int value, Update.Option option) throws NXException, RemoteException
title
- index
- value
- option
- NXException
RemoteException
void setInstanceUserAttribute(String title, int index, double value, Update.Option option) throws NXException, RemoteException
title
- index
- value
- option
- NXException
RemoteException
void setInstanceUserAttribute(String title, int index, String value, Update.Option option) throws NXException, RemoteException
title
- index
- value
- option
- NXException
RemoteException
void setInstanceUserAttribute(String title, int index, Update.Option option) throws NXException, RemoteException
title
- index
- option
- NXException
RemoteException
void setInstanceTimeUserAttribute(String title, int index, String value, Update.Option option) throws NXException, RemoteException
title
- index
- value
- The current date and time is used if
the value is null. See
NXObject.DateAndTimeFormat
for valid formats.option
- NXException
RemoteException
void setInstanceBooleanUserAttribute(String title, int index, boolean value, Update.Option option) throws NXException, RemoteException
title
- index
- value
- option
- NXException
RemoteException
boolean hasInstanceUserAttribute(String title, NXObject.AttributeType type, int index) throws NXException, RemoteException
NXObject.AttributeType.REFERENCE
.
Instead, use NXObject.AttributeType.STRING
.
title
- type
- index
- NXException
RemoteException
NXObject.AttributeInformation getInstanceUserAttribute(String title, NXObject.AttributeType type, int index) throws NXException, RemoteException
NXObject.getUserAttributes(nxopen.AttributeIterator)
.
The date format set by the Customer Defaults is used for attributes of type time.
NOTE: This method does not support the use of NXObject.AttributeType.REFERENCE
.
Instead, use NXObject.AttributeType.STRING
.
For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.
title
- type
- index
- NXException
RemoteException
boolean getInstanceBooleanUserAttribute(String title, int index) throws NXException, RemoteException
NXObject.getUserAttributes(nxopen.AttributeIterator)
.
title
- index
- NXException
RemoteException
int getInstanceIntegerUserAttribute(String title, int index) throws NXException, RemoteException
NXObject.getUserAttributes(nxopen.AttributeIterator)
.
title
- index
- NXException
RemoteException
double getInstanceRealUserAttribute(String title, int index) throws NXException, RemoteException
NXObject.getUserAttributes(nxopen.AttributeIterator)
.
title
- index
- NXException
RemoteException
String getInstanceStringUserAttribute(String title, int index) throws NXException, RemoteException
NXObject.getUserAttributes(nxopen.AttributeIterator)
.
Gets a string attribute value by title.
title
- index
- NXException
RemoteException
String getInstanceTimeUserAttribute(String title, int index) throws NXException, RemoteException
NXObject.getUserAttributes(nxopen.AttributeIterator)
.
Gets a time attribute by title.
title
- index
- NXException
RemoteException
NXObject.AttributeInformation[] getInstanceUserAttributes() throws NXException, RemoteException
NXObject.AttributeType.STRING
,
and both the ReferenceValue and the calculated StringValue are returned.
NXException
RemoteException
NXObject.AttributeInformation[] getInstanceUserAttributes(boolean includeUnset) throws NXException, RemoteException
NXObject.AttributeType.STRING
,
and both the ReferenceValue and the calculated StringValue are returned.
includeUnset
- NXException
RemoteException
String getInstanceUserAttributeAsString(String title, NXObject.AttributeType type, int index) throws NXException, RemoteException
NXObject.getUserAttributesAsStrings()
.
The date format set by the Customer Defaults is used for attributes of type time.
NOTE: This method does not support the use of NXObject.AttributeType.REFERENCE
.
Instead, use NXObject.AttributeType.STRING
.
For reference type string attributes, the calculated StringValue is returned.
title
- type
- index
- NXException
RemoteException
String[] getInstanceUserAttributesAsStrings() throws NXException, RemoteException
NXObject.AttributeType.REFERENCE
.
Reference type attributes return the calculated StringValue.
The date format set by the Customer Defaults is used.
NXException
RemoteException
void deleteInstanceUserAttribute(NXObject.AttributeType type, String title, boolean deleteEntireArray, Update.Option option) throws NXException, RemoteException
NXObject.AttributeType.REFERENCE
.
type
- title
- deleteEntireArray
- option
- NXException
RemoteException
void deleteInstanceUserAttributes(NXObject.AttributeType type, Update.Option option) throws NXException, RemoteException
NXObject.AttributeType.REFERENCE
.
type
- option
- NXException
RemoteException
void setInstanceUserAttributeLock(String title, NXObject.AttributeType type, boolean lock) throws NXException, RemoteException
title
- type
- lock
- NXException
RemoteException
boolean getInstanceUserAttributeLock(String title, NXObject.AttributeType type) throws NXException, RemoteException
title
- type
- NXException
RemoteException
Subset subset() throws NXException, RemoteException
Subset
that corresponds to this component.
This can be null if the component is not a subset.
NXException
RemoteException
CollaborativeContentType collaborativeContentType() throws NXException, RemoteException
NXException
RemoteException
DesignElementRevision designElementRevision() throws NXException, RemoteException
modelElementRevision()
instead.
DesignElementRevision
that corresponds to this component.
This can be null if the component is not a design element.
This will return parent reuse design element revision if this component represent a DesignSubordinateRevision
.
NXException
RemoteException
DesignSubordinateRevision designSubordinateRevision() throws NXException, RemoteException
DesignSubordinateRevision
that corresponds to this component.
This can be null if the component is not a subordinate design element.
NXException
RemoteException
InstanceSelectionCriteria createEmptyPartFamilyInstanceSelectionCriteria(Template family) throws NXException, RemoteException
InstanceSelectionCriteria
family
- NXException
RemoteException
InstanceSelectionCriteria getPartFamilyInstanceSelectionCriteria() throws NXException, RemoteException
InstanceSelectionCriteria
, if it exists.
NXException
RemoteException
void setPartFamilyInstanceSelectionCriteria(InstanceSelectionCriteria selectionCriteria) throws NXException, RemoteException
InstanceSelectionCriteria
to this component
selectionCriteria
- NXException
RemoteException
void deletePartFamilyInstanceSelectionCriteria() throws NXException, RemoteException
InstanceSelectionCriteria
associated with this component
NXException
RemoteException
Component.FindComponentPatternsData findComponentPatterns() throws NXException, RemoteException
ComponentPattern
associated with this component.
De-allocation of memory used for list of pattern definitions is responsibility of user.
NXException
RemoteException
ModelElementRevision modelElementRevision() throws NXException, RemoteException
ModelElementRevision
that corresponds to this component.
This can be null if the component is not a model element.
This will return parent reuse design element revision if this component represent a DesignSubordinateRevision
.
If component is independent design feature then this will return DesignFeatureRevision
.
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.