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

JA class for the Optical Annotation Settings dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOpticalAnnotationSettingsBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::AME::OpticalAnnotationSettingsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AnnotationAttrType { AnnotationAttrTypeSourceTarget, AnnotationAttrTypeFiberType, AnnotationAttrTypeCoreDiameter, AnnotationAttrTypeCladdingDiameter }
 Represents the type of annotations. More...
 

Public Member Functions

void GetAnnotationAttributes (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, std::vector< NXOpen::AME::OpticalAnnotationSettingsBuilder::AnnotationAttrType > &annotationAttrs)
 The annotation attributes for a given fiber type. More...
 
void ResetToDefault ()
 Reset to default. More...
 
void SetAnnotationAttributes (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, const std::vector< NXOpen::AME::OpticalAnnotationSettingsBuilder::AnnotationAttrType > &annotationAttrs)
 
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 Optical Annotation Settings dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOpticalAnnotationSettingsBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Represents the type of annotations.

Enumerator
AnnotationAttrTypeSourceTarget 

source target

AnnotationAttrTypeFiberType 

fiber type

AnnotationAttrTypeCoreDiameter 

core diameter

AnnotationAttrTypeCladdingDiameter 

cladding diameter

Member Function Documentation

void NXOpen::AME::OpticalAnnotationSettingsBuilder::GetAnnotationAttributes ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
std::vector< NXOpen::AME::OpticalAnnotationSettingsBuilder::AnnotationAttrType > &  annotationAttrs 
)

The annotation attributes for a given fiber type.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
annotationAttrsUser needs to free this memory.
void NXOpen::AME::OpticalAnnotationSettingsBuilder::ResetToDefault ( )

Reset to default.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::OpticalAnnotationSettingsBuilder::SetAnnotationAttributes ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
const std::vector< NXOpen::AME::OpticalAnnotationSettingsBuilder::AnnotationAttrType > &  annotationAttrs 
)


Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
annotationAttrsannotationattrs

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