NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Member Functions | List of all members
NXOpen::TDP::Manager Class Reference

Represents the TDP Manager class. More...

Public Member Functions

NXOpen::TDP::PublisherBuilderCreateTdpPublisherBuilder (NXOpen::Part *part)
 Creates the TDP Publisher builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateAutomaticTableBuilderCreateTemplateAutomaticTableBuilder (NXOpen::Part *part, NXOpen::TDP::TemplateAutomaticTable *automaticTable)
 Creates the Template Automatic Table builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateEditCellBuilderCreateTemplateEditcellBuilder (NXOpen::Part *part, NXOpen::DisplayableObject *tableCell)
 Creates the Template Edit cell builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateFormFieldBuilderCreateTemplateFormFieldBuilder (NXOpen::Part *part, NXOpen::TDP::TemplateFormField *formFieldTag)
 Creates the Template Form Field builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateImageBuilderCreateTemplateImageBuilder (NXOpen::Part *part, NXOpen::TDP::TemplateImage *imageToEdit)
 Creates the Template Image builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateNoteBuilderCreateTemplateNoteBuilder (NXOpen::Part *part, NXOpen::Annotations::SimpleDraftingAid *annotation)
 Creates the Template Note builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplatePageBuilderCreateTemplatePageBuilder (NXOpen::Part *part, NXOpen::TDP::TemplatePage *pageToEdit)
 Creates the Template Page builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplatePropertiesBuilderCreateTemplatePropertiesBuilder (NXOpen::Part *part)
 Creates the Template Properties builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateRectangleBuilderCreateTemplateRectangleBuilder (NXOpen::Part *part, NXOpen::TDP::TemplateRectangle *rectangle)
 Creates the Template Rectangle builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateTableSectionBuilderCreateTemplateTableSectionBuilder (NXOpen::Part *part, NXOpen::Annotations::TableSection *tableSectionToEdit)
 Creates the Template Table builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateViewCarouselBuilderCreateTemplateViewCarouselBuilder (NXOpen::Part *part, NXOpen::TDP::TemplateViewCarousel *viewCarousel)
 Creates the Template View Carousel builder
Created in NX1847.0.0. More...
 
NXOpen::TDP::TemplateViewportBuilderCreateTemplateViewportBuilder (NXOpen::Part *part, NXOpen::TDP::TemplateViewport *viewport)
 Creates the Template Viewport builder
Created in NX1847.0.0. More...
 
void Lock (const std::vector< NXOpen::DisplayableObject * > &templateObjects)
 Locks the specified template objects. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void Unlock (const std::vector< NXOpen::DisplayableObject * > &templateObjects)
 Unlocks the specified template objects. More...
 

Static Public Member Functions

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

Detailed Description

Represents the TDP Manager class.


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

Created in NX1847.0.0.

Member Function Documentation

NXOpen::TDP::PublisherBuilder* NXOpen::TDP::Manager::CreateTdpPublisherBuilder ( NXOpen::Part part)

Creates the TDP Publisher builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
NXOpen::TDP::TemplateAutomaticTableBuilder* NXOpen::TDP::Manager::CreateTemplateAutomaticTableBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplateAutomaticTable automaticTable 
)

Creates the Template Automatic Table builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
automaticTableautomatictable
NXOpen::TDP::TemplateEditCellBuilder* NXOpen::TDP::Manager::CreateTemplateEditcellBuilder ( NXOpen::Part part,
NXOpen::DisplayableObject tableCell 
)

Creates the Template Edit cell builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
tableCelltablecell
NXOpen::TDP::TemplateFormFieldBuilder* NXOpen::TDP::Manager::CreateTemplateFormFieldBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplateFormField formFieldTag 
)

Creates the Template Form Field builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
formFieldTagformfieldtag
NXOpen::TDP::TemplateImageBuilder* NXOpen::TDP::Manager::CreateTemplateImageBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplateImage imageToEdit 
)

Creates the Template Image builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
imageToEditimagetoedit
NXOpen::TDP::TemplateNoteBuilder* NXOpen::TDP::Manager::CreateTemplateNoteBuilder ( NXOpen::Part part,
NXOpen::Annotations::SimpleDraftingAid annotation 
)

Creates the Template Note builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
annotationNXOpen::Annotations::SimpleDraftingAid to be edited
NXOpen::TDP::TemplatePageBuilder* NXOpen::TDP::Manager::CreateTemplatePageBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplatePage pageToEdit 
)

Creates the Template Page builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
pageToEditpagetoedit
NXOpen::TDP::TemplatePropertiesBuilder* NXOpen::TDP::Manager::CreateTemplatePropertiesBuilder ( NXOpen::Part part)

Creates the Template Properties builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
NXOpen::TDP::TemplateRectangleBuilder* NXOpen::TDP::Manager::CreateTemplateRectangleBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplateRectangle rectangle 
)

Creates the Template Rectangle builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
rectanglerectangle
NXOpen::TDP::TemplateTableSectionBuilder* NXOpen::TDP::Manager::CreateTemplateTableSectionBuilder ( NXOpen::Part part,
NXOpen::Annotations::TableSection tableSectionToEdit 
)

Creates the Template Table builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
tableSectionToEdittablesectiontoedit
NXOpen::TDP::TemplateViewCarouselBuilder* NXOpen::TDP::Manager::CreateTemplateViewCarouselBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplateViewCarousel viewCarousel 
)

Creates the Template View Carousel builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
viewCarouselviewcarousel
NXOpen::TDP::TemplateViewportBuilder* NXOpen::TDP::Manager::CreateTemplateViewportBuilder ( NXOpen::Part part,
NXOpen::TDP::TemplateViewport viewport 
)

Creates the Template Viewport builder
Created in NX1847.0.0.



License requirements : None

Parameters
partpart
viewportviewport
static Manager* NXOpen::TDP::Manager::GetManager ( NXOpen::Session owner)
static

Returns the Manager 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::TDP::Manager::Lock ( const std::vector< NXOpen::DisplayableObject * > &  templateObjects)

Locks the specified template objects.


Created in NX1847.0.0.

License requirements : nx_tdp (" NX Technical Data Package")

Parameters
templateObjectsList of template objects
tag_t NXOpen::TDP::Manager::Tag ( ) const

Returns the tag of this object.

void NXOpen::TDP::Manager::Unlock ( const std::vector< NXOpen::DisplayableObject * > &  templateObjects)

Unlocks the specified template objects.


Created in NX1847.0.0.

License requirements : nx_tdp (" NX Technical Data Package")

Parameters
templateObjectsList of template objects

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