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

Represents a Manage2dSymbolsBuilder class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateManage2dSymbolsBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::Manage2dSymbolsBuilder:
NXOpen::AME::AMEBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SymbolRepresentationTypes {
  SymbolRepresentationTypesMultiLineSchematic, SymbolRepresentationTypesSingleLineSchematic, SymbolRepresentationTypesBusTopologyDiagram, SymbolRepresentationTypesPowerSupplyTopologyDiagram,
  SymbolRepresentationTypesGenericSchematic
}
 Representation type of symbol. More...
 

Public Member Functions

void AddAssignedSymbol (const NXString &symbolNameString)
 Adds the given 2d symbol to the assigned symbols list
Created in NX11.0.0. More...
 
void AddAssignedSymbol (const char *symbolNameString)
 Adds the given 2d symbol to the assigned symbols list
Created in NX11.0.0. More...
 
std::vector< NXStringGetAssignedSymbols (NXOpen::TaggedObject *objTag)
 Get assigned symbols. More...
 
NXString GetDefaultSymbol (NXOpen::TaggedObject *inputObject)
 Gets the default 2d symbol assigned to the input object. More...
 
void RemoveAssignedSymbol (const NXString &symbolNameString)
 Removes the given 2d symbol from the assigned symbols list
Created in NX11.0.0. More...
 
void RemoveAssignedSymbol (const char *symbolNameString)
 Removes the given 2d symbol from the assigned symbols list
Created in NX11.0.0. More...
 
void ResetDefaultSymbol ()
 Reset the default 2d symbol from the associated NXOpen::AME::ProductDefinition
Created in NX11.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeListSelectedObjects ()
 Returns the Target node selection
Created in NX11.0.0. More...
 
void SetDefaultSymbol (const NXString &symbolNameString)
 Sets the given 2d symbol as default on the input object
Created in NX11.0.0. More...
 
void SetDefaultSymbol (const char *symbolNameString)
 Sets the given 2d symbol as default on the input object
Created in NX11.0.0. More...
 
void SetSymbolRepresentationType (NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes symbolRepresentationType)
 Sets the representation type which could be of NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes
Created in NX11.0.0. More...
 
NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes SymbolRepresentationType ()
 Returns the representation type which could be of NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes
Created in NX11.0.0. More...
 

Detailed Description

Represents a Manage2dSymbolsBuilder class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateManage2dSymbolsBuilder
Default values.

Property Value

SymbolRepresentationType

MultiLineSchematic


Created in NX11.0.0.

Member Enumeration Documentation

Representation type of symbol.

Enumerator
SymbolRepresentationTypesMultiLineSchematic 

multi line schematic

SymbolRepresentationTypesSingleLineSchematic 

single line schematic

SymbolRepresentationTypesBusTopologyDiagram 

bus topology diagram

SymbolRepresentationTypesPowerSupplyTopologyDiagram 

power supply topology diagram

SymbolRepresentationTypesGenericSchematic 

generic schematic

Member Function Documentation

void NXOpen::AME::Manage2dSymbolsBuilder::AddAssignedSymbol ( const NXString symbolNameString)

Adds the given 2d symbol to the assigned symbols list
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolNameStringsymbolnamestring
void NXOpen::AME::Manage2dSymbolsBuilder::AddAssignedSymbol ( const char *  symbolNameString)

Adds the given 2d symbol to the assigned symbols list
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolNameStringsymbolnamestring
std::vector<NXString> NXOpen::AME::Manage2dSymbolsBuilder::GetAssignedSymbols ( NXOpen::TaggedObject objTag)

Get assigned symbols.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
objTagobjtag
NXString NXOpen::AME::Manage2dSymbolsBuilder::GetDefaultSymbol ( NXOpen::TaggedObject inputObject)

Gets the default 2d symbol assigned to the input object.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
inputObjectinputobject
void NXOpen::AME::Manage2dSymbolsBuilder::RemoveAssignedSymbol ( const NXString symbolNameString)

Removes the given 2d symbol from the assigned symbols list
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolNameStringsymbolnamestring
void NXOpen::AME::Manage2dSymbolsBuilder::RemoveAssignedSymbol ( const char *  symbolNameString)

Removes the given 2d symbol from the assigned symbols list
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolNameStringsymbolnamestring
void NXOpen::AME::Manage2dSymbolsBuilder::ResetDefaultSymbol ( )

Reset the default 2d symbol from the associated NXOpen::AME::ProductDefinition
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNodeList* NXOpen::AME::Manage2dSymbolsBuilder::SelectedObjects ( )

Returns the Target node selection
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::Manage2dSymbolsBuilder::SetDefaultSymbol ( const NXString symbolNameString)

Sets the given 2d symbol as default on the input object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolNameStringsymbolnamestring
void NXOpen::AME::Manage2dSymbolsBuilder::SetDefaultSymbol ( const char *  symbolNameString)

Sets the given 2d symbol as default on the input object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolNameStringsymbolnamestring
void NXOpen::AME::Manage2dSymbolsBuilder::SetSymbolRepresentationType ( NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes  symbolRepresentationType)

Sets the representation type which could be of NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
symbolRepresentationTypesymbolrepresentationtype
NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationType ( )

Returns the representation type which could be of NXOpen::AME::Manage2dSymbolsBuilder::SymbolRepresentationTypes
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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