NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder Class Reference

Represents a NXOpen.Annotations.PmiGeneralSetupEffectivityBuilder
Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PrimaryGeometryType { PrimaryGeometryTypeIfAllAssociatedOccurrencesareLoaded, PrimaryGeometryTypeIfAnyAssociatedOccurrencesareLoaded }
 the enum values which provides additional control over the display of PMI associated to primary geometry when Effectivity is being inferred More...
 
enum  ReferenceGeometryType { ReferenceGeometryTypeIfAllAssociatedOccurrencesareLoaded, ReferenceGeometryTypeIfAnyAssociatedOccurrencesareLoaded }
 the enum values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred More...
 

Public Member Functions

bool ComponentsLoadedForReference ()
 Returns the 'To Components Loaded for Reference' toggle value which determines whether or not PMI objects, which are associated to components that have been loaded for reference, are considered for display
Created in NX1847.0.0. More...
 
bool DisplayEffectivityFilteredNodes ()
 Returns the 'Display Effectivity Filtered Nodes' toggle value which determines whether or not the Effectivity Filtered PMI nodes are displayed in the Part Navigator
Created in NX1847.0.0. More...
 
NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::PrimaryGeometryType DisplayPmiAssociatedOnlyToPrimaryGeometry ()
 Returns the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0. More...
 
NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::ReferenceGeometryType DisplayPmiAssociatedToReferenceGeometry ()
 Returns the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0. More...
 
void SetComponentsLoadedForReference (bool componentsLoadedForReference)
 Sets the 'To Components Loaded for Reference' toggle value which determines whether or not PMI objects, which are associated to components that have been loaded for reference, are considered for display
Created in NX1847.0.0. More...
 
void SetDisplayEffectivityFilteredNodes (bool displayEffectivityFiltered)
 Sets the 'Display Effectivity Filtered Nodes' toggle value which determines whether or not the Effectivity Filtered PMI nodes are displayed in the Part Navigator
Created in NX1847.0.0. More...
 
void SetDisplayPmiAssociatedOnlyToPrimaryGeometry (NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::PrimaryGeometryType toPrimaryGeometry)
 Sets the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0. More...
 
void SetDisplayPmiAssociatedToReferenceGeometry (NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::ReferenceGeometryType toReferenceGeometry)
 Sets the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen.Annotations.PmiGeneralSetupEffectivityBuilder
Created in NX1847.0.0.


Member Enumeration Documentation

the enum values which provides additional control over the display of PMI associated to primary geometry when Effectivity is being inferred

Enumerator
PrimaryGeometryTypeIfAllAssociatedOccurrencesareLoaded 

the value which represents 'If All Associated Occurrences are Loaded' type for primary geometry

PrimaryGeometryTypeIfAnyAssociatedOccurrencesareLoaded 

the value which represents 'If Any Associated Occurrences are Loaded' type for primary geometry

the enum values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred

Enumerator
ReferenceGeometryTypeIfAllAssociatedOccurrencesareLoaded 

the value which represents 'If All Associated Occurrences are Loaded' type for reference geometry

ReferenceGeometryTypeIfAnyAssociatedOccurrencesareLoaded 

the value which represents 'If Any Associated Occurrences are Loaded' type for reference geometry

Member Function Documentation

bool NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::ComponentsLoadedForReference ( )

Returns the 'To Components Loaded for Reference' toggle value which determines whether or not PMI objects, which are associated to components that have been loaded for reference, are considered for display
Created in NX1847.0.0.



License requirements : None

bool NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::DisplayEffectivityFilteredNodes ( )

Returns the 'Display Effectivity Filtered Nodes' toggle value which determines whether or not the Effectivity Filtered PMI nodes are displayed in the Part Navigator
Created in NX1847.0.0.



License requirements : None

NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::PrimaryGeometryType NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::DisplayPmiAssociatedOnlyToPrimaryGeometry ( )

Returns the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0.



License requirements : None

NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::ReferenceGeometryType NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::DisplayPmiAssociatedToReferenceGeometry ( )

Returns the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0.



License requirements : None

void NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetComponentsLoadedForReference ( bool  componentsLoadedForReference)

Sets the 'To Components Loaded for Reference' toggle value which determines whether or not PMI objects, which are associated to components that have been loaded for reference, are considered for display
Created in NX1847.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
componentsLoadedForReferencecomponentsloadedforreference
void NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetDisplayEffectivityFilteredNodes ( bool  displayEffectivityFiltered)

Sets the 'Display Effectivity Filtered Nodes' toggle value which determines whether or not the Effectivity Filtered PMI nodes are displayed in the Part Navigator
Created in NX1847.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
displayEffectivityFiltereddisplayeffectivityfiltered
void NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetDisplayPmiAssociatedOnlyToPrimaryGeometry ( NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::PrimaryGeometryType  toPrimaryGeometry)

Sets the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
toPrimaryGeometrytoprimarygeometry
void NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetDisplayPmiAssociatedToReferenceGeometry ( NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::ReferenceGeometryType  toReferenceGeometry)

Sets the option values which provides additional control over the display of PMI associated to reference geometry when Effectivity is being inferred
Created in NX1847.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
toReferenceGeometrytoreferencegeometry
virtual bool NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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