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

A manager to deal with all objects. More...

Public Member Functions

NXOpen::PID::BulkEditBuilderCreateBulkEditBuilder (NXOpen::Part *part)
 Creates a NXOpen::PID::BulkEditBuilder. More...
 
NXOpen::PID::DesignContextBuilderCreateDesignContextBuilder ()
 Creates a NXOpen::PID::DesignContextBuilder. More...
 
NXOpen::PID::EquipmentBuilderCreateEquipmentBuilder (NXOpen::Part *part, NXOpen::PID::Equipment *equipment)
 Creates a NXOpen::PID::EquipmentBuilder . More...
 
NXOpen::PID::FileNewApplicationBuilderCreateFilenewapplicationBuilder ()
 Creates a NXOpen::PID::FileNewApplicationBuilder. More...
 
NXOpen::PID::FlowDirectionArrowBuilderCreateFlowDirectionArrowBuilder (NXOpen::Part *part, NXOpen::PID::FlowDirectionArrow *flowDirectionArrow)
 Creates a NXOpen::PID::FlowDirectionArrowBuilder . More...
 
NXOpen::PID::LibraryAuthoringBuilderCreateLibraryAuthoringBuilder (NXOpen::Part *part)
 Creates a NXOpen::PID::LibraryAuthoringBuilder . More...
 
NXOpen::PID::OffSheetConnectorBuilderCreateOffSheetConnectorBuilder (NXOpen::Part *part, NXOpen::PID::OffSheetConnector *oscObject)
 Creates a NXOpen::PID::OffSheetConnectorBuilder . More...
 
NXOpen::PID::PipeBuilderCreatePipeBuilder (NXOpen::Part *part, NXOpen::PID::Pipe *pipe)
 Creates a NXOpen::PID::PipeBuilder . More...
 
NXOpen::PID::PortEquipmentBuilderCreatePortEquipmentBuilder (NXOpen::Part *part, NXOpen::PID::PortEquipment *portEquipment)
 Creates a NXOpen::PID::PortEquipmentBuilder . More...
 
NXOpen::PID::PreferencesBuilderCreatePreferencesBuilder (NXOpen::Part *part, NXOpen::PID::Sheet *sheet)
 Creates a NXOpen::PID::PreferencesBuilder . More...
 
NXOpen::PID::SheetTemplateBuilderCreateSheetTemplateBuilder (NXOpen::Part *part, NXOpen::Diagramming::Sheet *sheet)
 Creates a NXOpen::PID::SheetTemplateBuilder. More...
 
void DeleteSheetElements (const std::vector< NXOpen::Diagramming::SheetElement * > &sheetElementsDel)
 Delete Sheet Elements. More...
 
void EnterLibraryAuthoring ()
 Enter Library Authoring Tool. More...
 
void ExitLibraryAuthoring ()
 Exit Library Authoring Tool. More...
 
void ExportRunManaged (const std::vector< NXOpen::NXObject * > &runTags, const NXString &destination)
 Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0. More...
 
void ExportRunManaged (const std::vector< NXOpen::NXObject * > &runTags, const char *destination)
 Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0. More...
 
void ExportRunNative (const std::vector< NXOpen::NXObject * > &runTags, const NXString &destination)
 Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0. More...
 
void ExportRunNative (const std::vector< NXOpen::NXObject * > &runTags, const char *destination)
 Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0. More...
 
void LoadSystem (NXOpen::Assemblies::Partition *system)
 Loads a NXOpen::Assemblies::Partition
Created in NX11.0.0. More...
 
void OpenSheet (NXOpen::PID::Sheet *sheet)
 Opens a NXOpen::PID::Sheet
Created in NX11.0.0. More...
 
void OpenSheetQuietly (NXOpen::PID::Sheet *sheet)
 Opens a NXOpen::PID::Sheet without displaying the sheet. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Static Public Member Functions

static PidManagerGetPidManager (NXOpen::Session *owner)
 Returns the PidManager object for the running session which serves as the 'gateway' class for the application API. More...
 

Detailed Description

A manager to deal with all objects.


To obtain an instance of this class, refer to NXOpen::Session

Created in NX11.0.1.

Member Function Documentation

NXOpen::PID::BulkEditBuilder* NXOpen::PID::PidManager::CreateBulkEditBuilder ( NXOpen::Part part)

Creates a NXOpen::PID::BulkEditBuilder.

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
Parameters
partpart
NXOpen::PID::DesignContextBuilder* NXOpen::PID::PidManager::CreateDesignContextBuilder ( )

Creates a NXOpen::PID::DesignContextBuilder.

Returns

Created in NX11.0.0.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
NXOpen::PID::EquipmentBuilder* NXOpen::PID::PidManager::CreateEquipmentBuilder ( NXOpen::Part part,
NXOpen::PID::Equipment equipment 
)

Creates a NXOpen::PID::EquipmentBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
equipmentNXOpen::PID::Equipment to be edited, if NULL then create a new one
NXOpen::PID::FileNewApplicationBuilder* NXOpen::PID::PidManager::CreateFilenewapplicationBuilder ( )

Creates a NXOpen::PID::FileNewApplicationBuilder.

Returns

Created in NX11.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
NXOpen::PID::FlowDirectionArrowBuilder* NXOpen::PID::PidManager::CreateFlowDirectionArrowBuilder ( NXOpen::Part part,
NXOpen::PID::FlowDirectionArrow flowDirectionArrow 
)

Creates a NXOpen::PID::FlowDirectionArrowBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
Parameters
partpart
flowDirectionArrowNXOpen::PID::FlowDirectionArrow to be edited, if NULL then create a new one
NXOpen::PID::LibraryAuthoringBuilder* NXOpen::PID::PidManager::CreateLibraryAuthoringBuilder ( NXOpen::Part part)

Creates a NXOpen::PID::LibraryAuthoringBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
NXOpen::PID::OffSheetConnectorBuilder* NXOpen::PID::PidManager::CreateOffSheetConnectorBuilder ( NXOpen::Part part,
NXOpen::PID::OffSheetConnector oscObject 
)

Creates a NXOpen::PID::OffSheetConnectorBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
oscObjectDiagramming::Annotation to be edited, if NULL then create a new one
NXOpen::PID::PipeBuilder* NXOpen::PID::PidManager::CreatePipeBuilder ( NXOpen::Part part,
NXOpen::PID::Pipe pipe 
)

Creates a NXOpen::PID::PipeBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
pipeDiagramming::Connection to be edited, if NULL then create a new one
NXOpen::PID::PortEquipmentBuilder* NXOpen::PID::PidManager::CreatePortEquipmentBuilder ( NXOpen::Part part,
NXOpen::PID::PortEquipment portEquipment 
)

Creates a NXOpen::PID::PortEquipmentBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
portEquipmentNXOpen::PID::PortEquipment to be edited, if NULL then create a new one
NXOpen::PID::PreferencesBuilder* NXOpen::PID::PidManager::CreatePreferencesBuilder ( NXOpen::Part part,
NXOpen::PID::Sheet sheet 
)

Creates a NXOpen::PID::PreferencesBuilder .

Returns

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
sheetsheet
NXOpen::PID::SheetTemplateBuilder* NXOpen::PID::PidManager::CreateSheetTemplateBuilder ( NXOpen::Part part,
NXOpen::Diagramming::Sheet sheet 
)

Creates a NXOpen::PID::SheetTemplateBuilder.

Returns

Created in NX11.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
Parameters
partthe part that will own the object
sheetsheet
void NXOpen::PID::PidManager::DeleteSheetElements ( const std::vector< NXOpen::Diagramming::SheetElement * > &  sheetElementsDel)

Delete Sheet Elements.


Created in NX11.0.1.

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

Parameters
sheetElementsDelSheet Elements to be checked
void NXOpen::PID::PidManager::EnterLibraryAuthoring ( )

Enter Library Authoring Tool.


Created in NX11.0.1.

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

void NXOpen::PID::PidManager::ExitLibraryAuthoring ( )

Exit Library Authoring Tool.


Created in NX11.0.1.

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

void NXOpen::PID::PidManager::ExportRunManaged ( const std::vector< NXOpen::NXObject * > &  runTags,
const NXString destination 
)

Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0.



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

Parameters
runTagsThe runs to be exported
destinationThe destination folder
void NXOpen::PID::PidManager::ExportRunManaged ( const std::vector< NXOpen::NXObject * > &  runTags,
const char *  destination 
)

Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0.



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

Parameters
runTagsThe runs to be exported
destinationThe destination folder
void NXOpen::PID::PidManager::ExportRunNative ( const std::vector< NXOpen::NXObject * > &  runTags,
const NXString destination 
)

Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0.



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

Parameters
runTagsThe runs to be exported
destinationThe destination folder
void NXOpen::PID::PidManager::ExportRunNative ( const std::vector< NXOpen::NXObject * > &  runTags,
const char *  destination 
)

Exports NXOpen::PDM::ElementGroup
Created in NX12.0.0.



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

Parameters
runTagsThe runs to be exported
destinationThe destination folder
static PidManager* NXOpen::PID::PidManager::GetPidManager ( NXOpen::Session owner)
static

Returns the PidManager object for the running session which serves as the 'gateway' class for the application API.

References to all other objects in this API are obtained either directly or indirectly via methods and properties on this class. Platform Session should be initialized using 'GetSession' method from NXOpen API prior to this call.

void NXOpen::PID::PidManager::LoadSystem ( NXOpen::Assemblies::Partition system)

Loads a NXOpen::Assemblies::Partition
Created in NX11.0.0.



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

Parameters
systemsystem
void NXOpen::PID::PidManager::OpenSheet ( NXOpen::PID::Sheet sheet)

Opens a NXOpen::PID::Sheet
Created in NX11.0.0.



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

Parameters
sheetsheet
void NXOpen::PID::PidManager::OpenSheetQuietly ( NXOpen::PID::Sheet sheet)

Opens a NXOpen::PID::Sheet without displaying the sheet.


Created in NX12.0.0.

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

Parameters
sheetsheet
tag_t NXOpen::PID::PidManager::Tag ( ) const

Returns the tag of this object.


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