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

Builder object for changing optical connection settings on diagramming pages associated with the NXOpen::AME::Project
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOpticalConnectionSettingsBuilder

Created in NX12.0.0. More...

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

Public Member Functions

double GetCladdingDiameter (NXOpen::AME::AmeOpticalConnectionFiberType fiberType)
 Fiber cladding diameter property of a given optical connection sub-type. More...
 
double GetCoreDiameter (NXOpen::AME::AmeOpticalConnectionFiberType fiberType)
 Fiber core diameter property of a given optical connection sub-type. More...
 
NXOpen::NXColorGetStyleColorCode (NXOpen::AME::AmeOpticalConnectionFiberType fiberType)
 Style color code property of a given optical connection sub-type. More...
 
NXOpen::DisplayableObject::ObjectFont GetStyleFont (NXOpen::AME::AmeOpticalConnectionFiberType fiberType)
 Style font property of a given optical connection sub-type. More...
 
NXOpen::DisplayableObject::ObjectWidth GetStyleWidth (NXOpen::AME::AmeOpticalConnectionFiberType fiberType)
 Style width property of a given optical connection sub-type. More...
 
void ResetToDefault ()
 Resets optical connection settings to default
Created in NX12.0.0. More...
 
void SetCladdingDiameter (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, double claddingDiameter)
 
Created in NX12.0.0. More...
 
void SetCoreDiameter (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, double coreDiameter)
 
Created in NX12.0.0. More...
 
void SetStyleColor (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, NXOpen::NXColor *styleColorCode)
 
Created in NX12.0.0. More...
 
void SetStyleFont (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, NXOpen::DisplayableObject::ObjectFont styleFont)
 
Created in NX12.0.0. More...
 
void SetStyleWidth (NXOpen::AME::AmeOpticalConnectionFiberType fiberType, NXOpen::DisplayableObject::ObjectWidth styleWidth)
 
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

Builder object for changing optical connection settings on diagramming pages associated with the NXOpen::AME::Project
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOpticalConnectionSettingsBuilder

Created in NX12.0.0.


Member Function Documentation

double NXOpen::AME::OpticalConnectionSettingsBuilder::GetCladdingDiameter ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType)

Fiber cladding diameter property of a given optical connection sub-type.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
fiberTypefibertype
double NXOpen::AME::OpticalConnectionSettingsBuilder::GetCoreDiameter ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType)

Fiber core diameter property of a given optical connection sub-type.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
fiberTypefibertype
NXOpen::NXColor* NXOpen::AME::OpticalConnectionSettingsBuilder::GetStyleColorCode ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType)

Style color code property of a given optical connection sub-type.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
fiberTypefibertype
NXOpen::DisplayableObject::ObjectFont NXOpen::AME::OpticalConnectionSettingsBuilder::GetStyleFont ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType)

Style font property of a given optical connection sub-type.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
fiberTypefibertype
NXOpen::DisplayableObject::ObjectWidth NXOpen::AME::OpticalConnectionSettingsBuilder::GetStyleWidth ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType)

Style width property of a given optical connection sub-type.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
fiberTypefibertype
void NXOpen::AME::OpticalConnectionSettingsBuilder::ResetToDefault ( )

Resets optical connection settings to default
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::OpticalConnectionSettingsBuilder::SetCladdingDiameter ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
double  claddingDiameter 
)


Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
claddingDiametercladdingdiameter
void NXOpen::AME::OpticalConnectionSettingsBuilder::SetCoreDiameter ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
double  coreDiameter 
)


Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
coreDiametercorediameter
void NXOpen::AME::OpticalConnectionSettingsBuilder::SetStyleColor ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
NXOpen::NXColor styleColorCode 
)


Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
styleColorCodestylecolorcode
void NXOpen::AME::OpticalConnectionSettingsBuilder::SetStyleFont ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
NXOpen::DisplayableObject::ObjectFont  styleFont 
)


Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
styleFontstylefont
void NXOpen::AME::OpticalConnectionSettingsBuilder::SetStyleWidth ( NXOpen::AME::AmeOpticalConnectionFiberType  fiberType,
NXOpen::DisplayableObject::ObjectWidth  styleWidth 
)


Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fiberTypefibertype
styleWidthstylewidth

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