NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::AME::EngineeringObjectAspectDetailBuilder Class Reference

JA class for the Engineering Object Aspect Detail UI block. More...

Inheritance diagram for NXOpen::AME::EngineeringObjectAspectDetailBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Columns { ColumnsType, ColumnsParent, ColumnsName }
 Aspect Detail columns. More...
 
enum  NameSource { NameSourceDefault, NameSourceNamingRule, NameSourceUserInput, NameSourceMapping }
 Aspect name from. More...
 

Public Member Functions

void AddNameAspect (const NXString &aspectType, const NXString &nameAspect)
 Adds a specific name for an aspect
Created in NX11.0.0. More...
 
void AddNameAspect (const char *aspectType, const char *nameAspect)
 Adds a specific name for an aspect
Created in NX11.0.0. More...
 
void AssignParent (const NXString &aspectName, NXOpen::NXObject *aspectType)
 Sets a parent aspect
Created in NX11.0.0. More...
 
void AssignParent (const char *aspectName, NXOpen::NXObject *aspectType)
 Sets a parent aspect
Created in NX11.0.0. More...
 
NXOpen::NXObjectGetParent (const NXString &aspectType)
 The parent aspect. More...
 
NXOpen::NXObjectGetParent (const char *aspectType)
 The parent aspect. More...
 
NXOpen::SelectNXObjectSelectionParent ()
 Returns the selection parent
Created in NX11.0.0. More...
 
void SetNameSource (const NXString &aspectType, NXOpen::AME::EngineeringObjectAspectDetailBuilder::NameSource source)
 Sets the source for aspect name
Created in NX11.0.0. More...
 
void SetNameSource (const char *aspectType, NXOpen::AME::EngineeringObjectAspectDetailBuilder::NameSource source)
 Sets the source for aspect name
Created in NX11.0.0. More...
 
void UnassignParent (const NXString &aspectType)
 Deletes a parent aspect
Created in NX11.0.0. More...
 
void UnassignParent (const char *aspectType)
 Deletes a parent aspect
Created in NX11.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

JA class for the Engineering Object Aspect Detail UI block.


Created in NX11.0.0.

Member Enumeration Documentation

Aspect Detail columns.

Enumerator
ColumnsType 

type

ColumnsParent 

parent

ColumnsName 

name

Aspect name from.

Enumerator
NameSourceDefault 

default

NameSourceNamingRule 

naming rule

NameSourceUserInput 

user input

NameSourceMapping 

mapping

Member Function Documentation

void NXOpen::AME::EngineeringObjectAspectDetailBuilder::AddNameAspect ( const NXString aspectType,
const NXString nameAspect 
)

Adds a specific name for an aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectTypeaspecttype
nameAspectnameaspect
void NXOpen::AME::EngineeringObjectAspectDetailBuilder::AddNameAspect ( const char *  aspectType,
const char *  nameAspect 
)

Adds a specific name for an aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectTypeaspecttype
nameAspectnameaspect
void NXOpen::AME::EngineeringObjectAspectDetailBuilder::AssignParent ( const NXString aspectName,
NXOpen::NXObject aspectType 
)

Sets a parent aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectNameaspectname
aspectTypeaspecttype
void NXOpen::AME::EngineeringObjectAspectDetailBuilder::AssignParent ( const char *  aspectName,
NXOpen::NXObject aspectType 
)

Sets a parent aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectNameaspectname
aspectTypeaspecttype
NXOpen::NXObject* NXOpen::AME::EngineeringObjectAspectDetailBuilder::GetParent ( const NXString aspectType)

The parent aspect.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
aspectTypeaspecttype
NXOpen::NXObject* NXOpen::AME::EngineeringObjectAspectDetailBuilder::GetParent ( const char *  aspectType)

The parent aspect.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
aspectTypeaspecttype
NXOpen::SelectNXObject* NXOpen::AME::EngineeringObjectAspectDetailBuilder::SelectionParent ( )

Returns the selection parent
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::EngineeringObjectAspectDetailBuilder::SetNameSource ( const NXString aspectType,
NXOpen::AME::EngineeringObjectAspectDetailBuilder::NameSource  source 
)

Sets the source for aspect name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectTypeaspecttype
sourcesource
void NXOpen::AME::EngineeringObjectAspectDetailBuilder::SetNameSource ( const char *  aspectType,
NXOpen::AME::EngineeringObjectAspectDetailBuilder::NameSource  source 
)

Sets the source for aspect name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectTypeaspecttype
sourcesource
void NXOpen::AME::EngineeringObjectAspectDetailBuilder::UnassignParent ( const NXString aspectType)

Deletes a parent aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectTypeaspecttype
void NXOpen::AME::EngineeringObjectAspectDetailBuilder::UnassignParent ( const char *  aspectType)

Deletes a parent aspect
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectTypeaspecttype
virtual bool NXOpen::AME::EngineeringObjectAspectDetailBuilder::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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.