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

Builder object for changing electrical connection settings on diagramming pages associated with the NXOpen::AME::Project . More...

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

Public Member Functions

NXOpen::NXColorGetStyleColorCode (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType)
 Style color code property of a given electrical connection sub-type. More...
 
NXOpen::DisplayableObject::ObjectFont GetStyleFont (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType)
 Style font property of a given electrical connection sub-type. More...
 
NXOpen::DisplayableObject::ObjectWidth GetStyleWidth (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType)
 Style width property of a given electrical connection sub-type. More...
 
NXString GetWireColorCode (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType)
 Wire color code property of a given electrical connection sub-type. More...
 
double GetWireCrossSection (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType)
 Wire cross section property of a given electrical connection sub-type. More...
 
NXString GetWireType (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType)
 Wire type property of a given electrical connection sub-type. More...
 
void ResetToDefault ()
 Resets electrical connection settings to default
Created in NX11.0.0. More...
 
void SetStyleColorCode (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, NXOpen::NXColor *styleColorCode)
 
Created in NX11.0.0. More...
 
void SetStyleFont (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, NXOpen::DisplayableObject::ObjectFont styleFont)
 
Created in NX11.0.0. More...
 
void SetStyleWidth (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, NXOpen::DisplayableObject::ObjectWidth styleWidth)
 
Created in NX11.0.0. More...
 
void SetWireColorCode (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, const NXString &wireColorCode)
 
Created in NX11.0.0. More...
 
void SetWireColorCode (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, const char *wireColorCode)
 
Created in NX11.0.0. More...
 
void SetWireCrossSection (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, double wireCrossSection)
 
Created in NX11.0.0. More...
 
void SetWireType (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, const NXString &wireType)
 
Created in NX11.0.0. More...
 
void SetWireType (NXOpen::AME::AmeElectricalConnectionPotentialType potentialType, const char *wireType)
 
Created in NX11.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 electrical connection settings on diagramming pages associated with the NXOpen::AME::Project .


To create a new instance of this class, use NXOpen::AME::AMEManager::CreateElectricalConnectionSettingsBuilder

Created in NX11.0.0.

Member Function Documentation

NXOpen::NXColor* NXOpen::AME::ElectricalConnectionSettingsBuilder::GetStyleColorCode ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType)

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

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
potentialTypepotentialtype
NXOpen::DisplayableObject::ObjectFont NXOpen::AME::ElectricalConnectionSettingsBuilder::GetStyleFont ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType)

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

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
potentialTypepotentialtype
NXOpen::DisplayableObject::ObjectWidth NXOpen::AME::ElectricalConnectionSettingsBuilder::GetStyleWidth ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType)

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

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
potentialTypepotentialtype
NXString NXOpen::AME::ElectricalConnectionSettingsBuilder::GetWireColorCode ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType)

Wire color code property of a given electrical connection sub-type.

Returns
Caller needs to free this memory.
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
potentialTypepotentialtype
double NXOpen::AME::ElectricalConnectionSettingsBuilder::GetWireCrossSection ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType)

Wire cross section property of a given electrical connection sub-type.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
potentialTypepotentialtype
NXString NXOpen::AME::ElectricalConnectionSettingsBuilder::GetWireType ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType)

Wire type property of a given electrical connection sub-type.

Returns
Caller needs to free this memory.
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
potentialTypepotentialtype
void NXOpen::AME::ElectricalConnectionSettingsBuilder::ResetToDefault ( )

Resets electrical connection settings to default
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetStyleColorCode ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
NXOpen::NXColor styleColorCode 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
styleColorCodestylecolorcode
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetStyleFont ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
NXOpen::DisplayableObject::ObjectFont  styleFont 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
styleFontstylefont
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetStyleWidth ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
NXOpen::DisplayableObject::ObjectWidth  styleWidth 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
styleWidthstylewidth
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetWireColorCode ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
const NXString wireColorCode 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
wireColorCodewirecolorcode
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetWireColorCode ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
const char *  wireColorCode 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
wireColorCodewirecolorcode
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetWireCrossSection ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
double  wireCrossSection 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
wireCrossSectionwirecrosssection
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetWireType ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
const NXString wireType 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
wireTypewiretype
void NXOpen::AME::ElectricalConnectionSettingsBuilder::SetWireType ( NXOpen::AME::AmeElectricalConnectionPotentialType  potentialType,
const char *  wireType 
)


Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
potentialTypepotentialtype
wireTypewiretype

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