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:

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::SelectComponentList *	SelectedObjects ()
	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.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
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.

Detailed Description

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

 <br> To create a new instance of this class, use @link PropertiesManager::CreateAssembliesGeneralPropertiesBuilder  PropertiesManager::CreateAssembliesGeneralPropertiesBuilder @endlink  <br> 

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

enum NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::HiddenOptions

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.

enum NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::LayerOptions

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.

enum NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::QuantityOptions

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.

enum NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::ReferenceComponentOptions

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

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::HiddenOptions NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::Hidden

(

)

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

int NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::IntegerQuantity

(

)

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

int NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::Layer

(

)

Returns the layer.

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

License requirements : None

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::LayerOptions NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::LayerOption

(

)

Returns the layer option.

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

License requirements : None

bool NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::NonGeometric

(

)

Returns the non geometric flag.

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

License requirements : None

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::QuantityOptions NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::QuantityType

(

)

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

double NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::RealQuantity

(

)

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

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::ReferenceComponentOptions NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::ReferenceComponent

(

)

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

NXOpen::Assemblies::SelectComponentList* NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SelectedObjects

(

)

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

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetHidden

(

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::HiddenOptions

hidden

)

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

hidden

hidden

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetIntegerQuantity

(

int

integerQuantity

)

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

integerQuantity

integerquantity

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetLayer

(

int

layer

)

Sets the layer.

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

License requirements : None

Parameters

layer

layer

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetLayerOption

(

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::LayerOptions

layerOption

)

Sets the layer option.

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

License requirements : None

Parameters

layerOption

layeroption

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetNonGeometric

(

bool

nonGeometric

)

Sets the non geometric flag.

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

License requirements : None

Parameters

nonGeometric

nongeometric

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetQuantityType

(

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::QuantityOptions

quantityType

)

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

quantityType

quantitytype

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetRealQuantity

(

double

realQuantity

)

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

realQuantity

realquantity

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetReferenceComponent

(

NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::ReferenceComponentOptions

referenceComponent

)

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

referenceComponent

referencecomponent

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetSpecificColor

(

bool

specificColor

)

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

specificColor

specificcolor

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetSpecificPartialShade

(

bool

specificPartialShade

)

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

specificPartialShade

specificpartialshade

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SetSpecificTranslucency

(

bool

specificTranslucency

)

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

specificTranslucency

specifictranslucency

bool NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SpecificColor

(

)

Returns the specific color flag.

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

License requirements : None

bool NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SpecificPartialShade

(

)

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

bool NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SpecificTranslucency

(

)

Returns the specific translucency flag.

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

License requirements : None

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SynchronizeAttributes

(

)

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

License requirements : None

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SynchronizeDisplay

(

)

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

License requirements : None

void NXOpen::Assemblies::AssembliesGeneralPropertiesBuilder::SynchronizeLayers

(

)

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:

• Assemblies_AssembliesGeneralPropertiesBuilder.hxx