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

Represents a LibraryAuthoringBuilder. More...

Inheritance diagram for NXOpen::PID::LibraryAuthoringBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::DiagrammingLibraryAuthor::AttributeHolderCreate3DSymbol (const NXString &instanceId, const NXString &partId, const NXString &partName, const NXString &numberName)
 Creates a new 3D symbol. More...
 
NXOpen::DiagrammingLibraryAuthor::AttributeHolderCreate3DSymbol (const char *instanceId, const char *partId, const char *partName, const char *numberName)
 Creates a new 3D symbol. More...
 
NXOpen::DiagrammingLibraryAuthor::LineTypeBuilderCreateLineType ()
 Creates a new line type. More...
 
void Delete3DSymbol (NXOpen::DiagrammingLibraryAuthor::AttributeHolder *symbolObject)
 Deletes the 3D symbol which is new created
Created in NX11.0.1. More...
 
void GetSymbolObjects (std::vector< NXOpen::DiagrammingLibraryAuthor::AttributeHolder * > &symbolObjects)
 Gets the symbol objects which have user attributes of the symbol. More...
 
NXOpen::DiagrammingLibraryAuthor::LineTypeBuilderListLineTypes ()
 Returns the list of line types. More...
 
NXOpen::DiagrammingLibraryAuthor::PipeStockBuilderPipeStock ()
 Returns the pipe stock sub-builder. More...
 
void SelectFolder (const NXString &classId, const NXString &symbolId)
 Selects the all symbols in the folder by the 2D symbol ID
Created in NX11.0.1. More...
 
void SelectFolder (const char *classId, const char *symbolId)
 Selects the all symbols in the folder by the 2D symbol ID
Created in NX11.0.1. More...
 
void SelectSymbol (const NXString &symbolId)
 Selects one 2D symbol or 3D symbol by the symbol ID
Created in NX11.0.1. More...
 
void SelectSymbol (const char *symbolId)
 Selects one 2D symbol or 3D symbol by the symbol ID
Created in NX11.0.1. More...
 
NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilderSymbol2D ()
 Returns the symbol 2D sub-builder. More...
 
NXOpen::DiagrammingLibraryAuthor::Symbol3DBuilderSymbol3D ()
 Returns the symbol 3D sub-builder. 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

Represents a LibraryAuthoringBuilder.

Calling Builder::Commit on this builder will only return NULL.
To create a new instance of this class, use NXOpen::PID::PidManager::CreateLibraryAuthoringBuilder
Default values.

Property Value

Symbol2D.Image.CaptureMethod

GraphicsArea

Symbol2D.Image.Format

Bmp

Symbol2D.Image.Size

Pixels64


Created in NX11.0.1.

Member Function Documentation

NXOpen::DiagrammingLibraryAuthor::AttributeHolder* NXOpen::PID::LibraryAuthoringBuilder::Create3DSymbol ( const NXString instanceId,
const NXString partId,
const NXString partName,
const NXString numberName 
)

Creates a new 3D symbol.

Returns
the symbol object
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
Parameters
instanceIdinstanceid
partIdpartid
partNamepartname
numberNamenumbername
NXOpen::DiagrammingLibraryAuthor::AttributeHolder* NXOpen::PID::LibraryAuthoringBuilder::Create3DSymbol ( const char *  instanceId,
const char *  partId,
const char *  partName,
const char *  numberName 
)

Creates a new 3D symbol.

Returns
the symbol object
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
Parameters
instanceIdinstanceid
partIdpartid
partNamepartname
numberNamenumbername
NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder* NXOpen::PID::LibraryAuthoringBuilder::CreateLineType ( )

Creates a new line type.

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
void NXOpen::PID::LibraryAuthoringBuilder::Delete3DSymbol ( NXOpen::DiagrammingLibraryAuthor::AttributeHolder symbolObject)

Deletes the 3D symbol which is new created
Created in NX11.0.1.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
symbolObjectthe symbol object, only accept the object which is got by NXOpen::PID::LibraryAuthoringBuilder::Create3DSymbol
void NXOpen::PID::LibraryAuthoringBuilder::GetSymbolObjects ( std::vector< NXOpen::DiagrammingLibraryAuthor::AttributeHolder * > &  symbolObjects)

Gets the symbol objects which have user attributes of the symbol.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
symbolObjectsthe symbol objects
NXOpen::DiagrammingLibraryAuthor::LineTypeBuilderList* NXOpen::PID::LibraryAuthoringBuilder::LineTypes ( )

Returns the list of line types.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::DiagrammingLibraryAuthor::PipeStockBuilder* NXOpen::PID::LibraryAuthoringBuilder::PipeStock ( )

Returns the pipe stock sub-builder.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::LibraryAuthoringBuilder::SelectFolder ( const NXString classId,
const NXString symbolId 
)

Selects the all symbols in the folder by the 2D symbol ID
Created in NX11.0.1.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
classIdclassid
symbolIdsymbolid
void NXOpen::PID::LibraryAuthoringBuilder::SelectFolder ( const char *  classId,
const char *  symbolId 
)

Selects the all symbols in the folder by the 2D symbol ID
Created in NX11.0.1.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
classIdclassid
symbolIdsymbolid
void NXOpen::PID::LibraryAuthoringBuilder::SelectSymbol ( const NXString symbolId)

Selects one 2D symbol or 3D symbol by the symbol ID
Created in NX11.0.1.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
symbolIdsymbolid
void NXOpen::PID::LibraryAuthoringBuilder::SelectSymbol ( const char *  symbolId)

Selects one 2D symbol or 3D symbol by the symbol ID
Created in NX11.0.1.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
symbolIdsymbolid
NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder* NXOpen::PID::LibraryAuthoringBuilder::Symbol2D ( )

Returns the symbol 2D sub-builder.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::DiagrammingLibraryAuthor::Symbol3DBuilder* NXOpen::PID::LibraryAuthoringBuilder::Symbol3D ( )

Returns the symbol 3D sub-builder.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")


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