NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder Class Reference

Represents an Assemblies::AssembliesGeneralPropertiesBuilder to be used for changing the general properties of a component. More...

Inheritance diagram for NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  HiddenOptions { HiddenOptionsNo, HiddenOptionsYes, HiddenOptionsMixed }
 Options for managing the hidden property on the components. More...
enum  LayerOptions { LayerOptionsOriginalLayer, LayerOptionsSpecifiedLayer, LayerOptionsMixed }
 Layer options for the components. More...
enum  QuantityOptions { QuantityOptionsNumber, QuantityOptionsAsRequired }
 Options for assigning the quantity on the components. More...
enum  ReferenceComponentOptions { ReferenceComponentOptionsNo, ReferenceComponentOptionsYes, ReferenceComponentOptionsMixed }
 Options for setting the reference-only property on the components. More...

Public Member Functions

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::HiddenOptions Hidden ()
 Returns the hidden option.
int IntegerQuantity ()
 Returns the integer quantity.
int Layer ()
 Returns the layer.
NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::LayerOptions LayerOption ()
 Returns the layer option.
bool NonGeometric ()
 Returns the non geometric flag.
NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::QuantityOptions QuantityType ()
 Returns the quantity type.
double RealQuantity ()
 Returns the real quantity.
NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::ReferenceComponentOptions ReferenceComponent ()
 Returns the reference-only component flag.
NXOpen::Assemblies::SelectComponentListSelectedObjects ()
 Returns the selected object(s) list.
void SetHidden (NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::HiddenOptions hidden)
 Sets the hidden option.
void SetIntegerQuantity (int integerQuantity)
 Sets the integer quantity.
void SetLayer (int layer)
 Sets the layer.
void SetLayerOption (NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::LayerOptions layerOption)
 Sets the layer option.
void SetNonGeometric (bool nonGeometric)
 Sets the non geometric flag.
void SetQuantityType (NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::QuantityOptions quantityType)
 Sets the quantity type.
void SetRealQuantity (double realQuantity)
 Sets the real quantity.
void SetReferenceComponent (NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::ReferenceComponentOptions referenceComponent)
 Sets the reference-only component flag.
void SetSpecificColor (bool specificColor)
 Sets the specific color flag.
void SetSpecificPartialShade (bool specificPartialShade)
 Sets the specific partial shade flag.
void SetSpecificTranslucency (bool specificTranslucency)
 Sets the specific translucency flag.
bool SpecificColor ()
 Returns the specific color flag.
bool SpecificPartialShade ()
 Returns the specific partial shade flag.
bool SpecificTranslucency ()
 Returns the specific translucency flag.
void SynchronizeAttributes ()
 Synchronize the attributes on the components
Created in NX8.0.0.
void SynchronizeDisplay ()
 Synchronize the display on the components
Created in NX8.0.0.
void SynchronizeLayers ()
 Synchronize the layers on the components
Created in NX8.0.0.

Detailed Description

Represents an Assemblies::AssembliesGeneralPropertiesBuilder to be used for changing the general properties of a component.


To create a new instance of this class, use PropertiesManager::CreateAssembliesGeneralPropertiesBuilder
Default values.

Property Value

Hidden

No

IntegerQuantity

0

Layer

0

LayerOption

OriginalLayer

NonGeometric

0

QuantityType

Number

RealQuantity

0

ReferenceComponent

No

SpecificColor

0

SpecificPartialShade

0

SpecificTranslucency

0


Created in NX8.0.0.


Member Enumeration Documentation

Options for managing the hidden property on the components.

Enumerator:
HiddenOptionsNo 

Do not hide the objects.

HiddenOptionsYes 

Hide the objects.

HiddenOptionsMixed 

Objects hidden properties differ and will not change.

Layer options for the components.

Enumerator:
LayerOptionsOriginalLayer 

Objects will be placed on original layer.

LayerOptionsSpecifiedLayer 

Objects will be placed on a user specified layer.

LayerOptionsMixed 

Objects are on different layers and will not be changed.

Options for assigning the quantity on the components.

Enumerator:
QuantityOptionsNumber 

Use either the integer or real value to set the quantity.

QuantityOptionsAsRequired 

Sets the as-required quantity on this component.

Options for setting the reference-only property on the components.

Enumerator:
ReferenceComponentOptionsNo 

Objects will be non reference-only components.

ReferenceComponentOptionsYes 

Objects will be reference-only components.

ReferenceComponentOptionsMixed 

Objects are a mixture of reference-only and non reference-only components, and will not be changed.


Member Function Documentation

Returns the hidden option.

The hidden option will be "Yes" if all the objects are hidden, "No" if all the objects are not hidden, and "Mixed" if there is a combination.
Created in NX8.0.0.

License requirements : None

Returns the integer quantity.

This value will be used if the Quantity Type is set to Number and the DB_UNITS attribute is not set.
Created in NX8.0.0.

License requirements : None

Returns the layer.

Used if the layer option is set to specified.
Created in NX8.0.0.

License requirements : None

Returns the layer option.

If specified layer is set, then the layer will be used.
Created in NX8.0.0.

License requirements : None

Returns the non geometric flag.

Sets the components to either geometric or non-geometric.
Created in NX8.0.0.

License requirements : None

Returns the quantity type.

If the quantity type is set to number than either the integer quantity or the real quantity values will be used. Otherwise the quantity will be set to as-required.
Created in NX8.0.0.

License requirements : None

Returns the real quantity.

This value will be used if the Quantity Type is set to Number and the DB_UNITS attribute has been set.
Created in NX8.0.0.

License requirements : None

Returns the reference-only component flag.

This option determines whether the components will be reference-only or not.
Created in NX8.0.0.

License requirements : None

Returns the selected object(s) list.

This is the active list of components that will be modified by any changes.
Created in NX8.0.0.

License requirements : None

Sets the hidden option.

The hidden option will be "Yes" if all the objects are hidden, "No" if all the objects are not hidden, and "Mixed" if there is a combination.
Created in NX8.0.0.

License requirements : None

Parameters:
hiddenhidden

Sets the integer quantity.

This value will be used if the Quantity Type is set to Number and the DB_UNITS attribute is not set.
Created in NX8.0.0.

License requirements : None

Parameters:
integerQuantityintegerquantity

Sets the layer.

Used if the layer option is set to specified.
Created in NX8.0.0.

License requirements : None

Parameters:
layerlayer

Sets the layer option.

If specified layer is set, then the layer will be used.
Created in NX8.0.0.

License requirements : None

Parameters:
layerOptionlayeroption

Sets the non geometric flag.

Sets the components to either geometric or non-geometric.
Created in NX8.0.0.

License requirements : None

Parameters:
nonGeometricnongeometric

Sets the quantity type.

If the quantity type is set to number than either the integer quantity or the real quantity values will be used. Otherwise the quantity will be set to as-required.
Created in NX8.0.0.

License requirements : None

Parameters:
quantityTypequantitytype

Sets the real quantity.

This value will be used if the Quantity Type is set to Number and the DB_UNITS attribute has been set.
Created in NX8.0.0.

License requirements : None

Parameters:
realQuantityrealquantity

Sets the reference-only component flag.

This option determines whether the components will be reference-only or not.
Created in NX8.0.0.

License requirements : None

Parameters:
referenceComponentreferencecomponent

Sets the specific color flag.

The explicit color display property will be discarded from all components.
Created in NX8.0.0.

License requirements : None

Parameters:
specificColorspecificcolor

Sets the specific partial shade flag.

The explicit partial shade display property will be discarded from all components.
Created in NX8.0.0.

License requirements : None

Parameters:
specificPartialShadespecificpartialshade

Sets the specific translucency flag.

The explicit translucency display property will be discarded from all components.
Created in NX8.0.0.

License requirements : None

Parameters:
specificTranslucencyspecifictranslucency

Returns the specific color flag.

The explicit color display property will be discarded from all components.
Created in NX8.0.0.

License requirements : None

Returns the specific partial shade flag.

The explicit partial shade display property will be discarded from all components.
Created in NX8.0.0.

License requirements : None

Returns the specific translucency flag.

The explicit translucency display property will be discarded from all components.
Created in NX8.0.0.

License requirements : None

Synchronize the attributes on the components
Created in NX8.0.0.



License requirements : None

Synchronize the display on the components
Created in NX8.0.0.



License requirements : None

Synchronize the layers on the components
Created in NX8.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.