NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::ShipDesign::PenetrationUtils Class Reference

Contains various penetration utility methods
To obtain an instance of this class, refer to NXOpen::Features::ShipDesign::PenetrationManager

Created in NX8.0.0. More...

Public Types

enum  Referencetype {
  ReferencetypePenetrated, ReferencetypePenetrating, ReferencetypeReference, ReferencetypeSubset,
  ReferencetypeImplemented
}
 Represents the reference type. More...
 
enum  RequestState {
  RequestStateNew, RequestStateModified, RequestStateNoChange, RequestStateDeleted,
  RequestStatePenetrationAttachOutOfDate
}
 Representes the request state. More...
 

Public Member Functions

void AskAssociateRequests (NXOpen::Features::ShipDesign::PenetrationRequest *request, std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests)
 Ask the associate requests
Created in NX8.0.0. More...
 
void AskAttachments (NXOpen::Features::ShipDesign::PenetrationFolder *folder, const NXString &relation, std::vector< NXOpen::Features::ShipDesign::PenetrationAttachment * > &attachments)
 Get the attachments in folder
Created in NX8.0.0. More...
 
void AskAttachments (NXOpen::Features::ShipDesign::PenetrationFolder *folder, const char *relation, std::vector< NXOpen::Features::ShipDesign::PenetrationAttachment * > &attachments)
 Get the attachments in folder
Created in NX8.0.0. More...
 
NXOpen::Features::ShipDesign::PenetrationSiteAskCurrentSite ()
 Ask current NXOpen::Features::ShipDesign::PenetrationSite. More...
 
NXOpen::Features::ShipDesign::PenetrationFolderAskReferenceFolder (NXOpen::Features::ShipDesign::PenetrationRequest *request, NXOpen::Features::ShipDesign::PenetrationUtils::Referencetype refType)
 Get the reference folder NXOpen::Features::ShipDesign::PenetrationFolder. More...
 
void AskRequestLists (std::vector< NXOpen::Features::ShipDesign::PenetrationList * > &list)
 Ask current NXOpen::Features::ShipDesign::PenetrationList
Created in NX8.0.0. More...
 
void AskRequestsOfPenetratedPart (NXOpen::Part *part, std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests)
 Ask requests of penetrated parts
Created in NX8.0.0. More...
 
void AskRequestsOfPenetratingPart (NXOpen::Part *part, std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests)
 Ask requests of penetratint parts
Created in NX8.0.0. More...
 
NXOpen::Features::ShipDesign::PenetrationListAskWorkingList ()
 Ask current NXOpen::Features::ShipDesign::PenetrationList. More...
 
void AssociateRequests (const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests)
 Ask the associate requests
Created in NX8.0.0. More...
 
NXOpen::Features::ShipDesign::PenetrationAttachmentCreatePenetrationAttachment (NXOpen::Features::ShipDesign::PenetrationSite *site)
 Creates a NXOpen::Features::ShipDesign::PenetrationAttachment. More...
 
NXOpen::Features::ShipDesign::PenetrationFolderCreatePenetrationFolder (NXOpen::Features::ShipDesign::PenetrationFolder *parent)
 Creates a NXOpen::Features::ShipDesign::PenetrationFolder. More...
 
NXOpen::Features::ShipDesign::PenetrationListCreatePenetrationList (NXOpen::Features::ShipDesign::PenetrationSite *site)
 Creates a NXOpen::Features::ShipDesign::PenetrationList. More...
 
NXOpen::Features::ShipDesign::PenetrationSiteCreatePenetrationSite (NXOpen::Part *part)
 Creates a NXOpen::Features::ShipDesign::PenetrationSite. More...
 
void GetAttachmentPartsFromRequest (NXOpen::Features::ShipDesign::PenetrationRequest *request, const NXString &relation, bool loadParts, std::vector< NXOpen::Part * > &pParts)
 Get attachment part from request
Created in NX8.5.0. More...
 
void GetAttachmentPartsFromRequest (NXOpen::Features::ShipDesign::PenetrationRequest *request, const char *relation, bool loadParts, std::vector< NXOpen::Part * > &pParts)
 Get attachment part from request
Created in NX8.5.0. More...
 
void InsertAttachment (NXOpen::Features::ShipDesign::PenetrationFolder *folder, NXOpen::Part *part, const NXString &name, const NXString &relation)
 Insert an attachment into folder
Created in NX8.0.0. More...
 
void InsertAttachment (NXOpen::Features::ShipDesign::PenetrationFolder *folder, NXOpen::Part *part, const char *name, const char *relation)
 Insert an attachment into folder
Created in NX8.0.0. More...
 
void ReloadRequests (NXOpen::Features::ShipDesign::PenetrationList *list)
 Set current NXOpen::Features::ShipDesign::PenetrationList
Created in NX8.0.0. More...
 
void RemoveAttachment (NXOpen::Features::ShipDesign::PenetrationFolder *folder, NXOpen::Features::ShipDesign::PenetrationAttachment *attachments)
 Remove an attachment from folder
Created in NX8.0.0. More...
 
void RequestCreateCutout (NXOpen::Features::ShipDesign::PenetrationRequest *request)
 Create cut out for the request
Created in NX8.5.0. More...
 
void ReviewRequests (const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests, const NXString &pchReviewDecision, const NXString &pchReviewComments, const NXString &pchDueDate)
 Review the requests
Created in NX8.5.0. More...
 
void ReviewRequests (const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests, const char *pchReviewDecision, const char *pchReviewComments, const char *pchDueDate)
 Review the requests
Created in NX8.5.0. More...
 
void SaveRequests (int eSaveRequestType, const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests)
 Save the requests
Created in NX8.5.0. More...
 
void SendToWorkflowRequests (const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests)
 Send to Workflow the requests
Created in NX8.5.0. More...
 
void SetContextValues (NXOpen::Part *rootPart, NXOpen::Part *workPart, NXOpen::View *workView, NXOpen::NXObject *workOcc)
 Set the CONTEXT values
Created in NX8.5.0. More...
 
void SetCurrentSite (NXOpen::Features::ShipDesign::PenetrationSite *site)
 Set current NXOpen::Features::ShipDesign::PenetrationSite
Created in NX8.0.0. More...
 
void SetRootPart (NXOpen::Part *part)
 Make part root part and work part
Created in NX8.5.0. More...
 
void SetWorkingList (NXOpen::Features::ShipDesign::PenetrationSite *site, NXOpen::Features::ShipDesign::PenetrationList *list)
 Set current NXOpen::Features::ShipDesign::PenetrationList
Created in NX8.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void VerifyPenetrations (const std::vector< NXOpen::Part * > &routingPart, std::vector< NXOpen::Features::ShipDesign::PenetrationUtils::RequestState > &states, std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &requests, std::vector< int > &reason)
 Verify penetrations
Created in NX8.0.0. More...
 

Detailed Description

Contains various penetration utility methods
To obtain an instance of this class, refer to NXOpen::Features::ShipDesign::PenetrationManager

Created in NX8.0.0.


Member Enumeration Documentation

Represents the reference type.

Enumerator
ReferencetypePenetrated 

penetrated

ReferencetypePenetrating 

penetrating

ReferencetypeReference 

reference

ReferencetypeSubset 

subset

ReferencetypeImplemented 

implemented

Representes the request state.

Enumerator
RequestStateNew 

new

RequestStateModified 

modified

RequestStateNoChange 

no change

RequestStateDeleted 

deleted

RequestStatePenetrationAttachOutOfDate 

penetration attach out of date

Member Function Documentation

void NXOpen::Features::ShipDesign::PenetrationUtils::AskAssociateRequests ( NXOpen::Features::ShipDesign::PenetrationRequest request,
std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests 
)

Ask the associate requests
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestrequest
requestsrequests
void NXOpen::Features::ShipDesign::PenetrationUtils::AskAttachments ( NXOpen::Features::ShipDesign::PenetrationFolder folder,
const NXString relation,
std::vector< NXOpen::Features::ShipDesign::PenetrationAttachment * > &  attachments 
)

Get the attachments in folder
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
folderfolder
relationrelation
attachmentsattachments
void NXOpen::Features::ShipDesign::PenetrationUtils::AskAttachments ( NXOpen::Features::ShipDesign::PenetrationFolder folder,
const char *  relation,
std::vector< NXOpen::Features::ShipDesign::PenetrationAttachment * > &  attachments 
)

Get the attachments in folder
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
folderfolder
relationrelation
attachmentsattachments
NXOpen::Features::ShipDesign::PenetrationSite* NXOpen::Features::ShipDesign::PenetrationUtils::AskCurrentSite ( )

Ask current NXOpen::Features::ShipDesign::PenetrationSite.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")

Get the reference folder NXOpen::Features::ShipDesign::PenetrationFolder.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")
Parameters
requestrequest
refTyperef type
void NXOpen::Features::ShipDesign::PenetrationUtils::AskRequestLists ( std::vector< NXOpen::Features::ShipDesign::PenetrationList * > &  list)

Ask current NXOpen::Features::ShipDesign::PenetrationList
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
listlist
void NXOpen::Features::ShipDesign::PenetrationUtils::AskRequestsOfPenetratedPart ( NXOpen::Part part,
std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests 
)

Ask requests of penetrated parts
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
partpart
requestsrequests
void NXOpen::Features::ShipDesign::PenetrationUtils::AskRequestsOfPenetratingPart ( NXOpen::Part part,
std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests 
)

Ask requests of penetratint parts
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
partpart
requestsrequests
NXOpen::Features::ShipDesign::PenetrationList* NXOpen::Features::ShipDesign::PenetrationUtils::AskWorkingList ( )

Ask current NXOpen::Features::ShipDesign::PenetrationList.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")
void NXOpen::Features::ShipDesign::PenetrationUtils::AssociateRequests ( const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests)

Ask the associate requests
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestsrequests
NXOpen::Features::ShipDesign::PenetrationAttachment* NXOpen::Features::ShipDesign::PenetrationUtils::CreatePenetrationAttachment ( NXOpen::Features::ShipDesign::PenetrationSite site)

Creates a NXOpen::Features::ShipDesign::PenetrationAttachment.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")
Parameters
sitesite
NXOpen::Features::ShipDesign::PenetrationFolder* NXOpen::Features::ShipDesign::PenetrationUtils::CreatePenetrationFolder ( NXOpen::Features::ShipDesign::PenetrationFolder parent)

Creates a NXOpen::Features::ShipDesign::PenetrationFolder.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")
Parameters
parentparent
NXOpen::Features::ShipDesign::PenetrationList* NXOpen::Features::ShipDesign::PenetrationUtils::CreatePenetrationList ( NXOpen::Features::ShipDesign::PenetrationSite site)

Creates a NXOpen::Features::ShipDesign::PenetrationList.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")
Parameters
sitesite
NXOpen::Features::ShipDesign::PenetrationSite* NXOpen::Features::ShipDesign::PenetrationUtils::CreatePenetrationSite ( NXOpen::Part part)

Creates a NXOpen::Features::ShipDesign::PenetrationSite.

Returns

Created in NX8.0.0.

License requirements : nx_penetration_mgmt ("Penetration Management")
Parameters
partpart
void NXOpen::Features::ShipDesign::PenetrationUtils::GetAttachmentPartsFromRequest ( NXOpen::Features::ShipDesign::PenetrationRequest request,
const NXString relation,
bool  loadParts,
std::vector< NXOpen::Part * > &  pParts 
)

Get attachment part from request
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestrequest
relationrelation
loadPartsload parts
pPartspparts
void NXOpen::Features::ShipDesign::PenetrationUtils::GetAttachmentPartsFromRequest ( NXOpen::Features::ShipDesign::PenetrationRequest request,
const char *  relation,
bool  loadParts,
std::vector< NXOpen::Part * > &  pParts 
)

Get attachment part from request
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestrequest
relationrelation
loadPartsload parts
pPartspparts
void NXOpen::Features::ShipDesign::PenetrationUtils::InsertAttachment ( NXOpen::Features::ShipDesign::PenetrationFolder folder,
NXOpen::Part part,
const NXString name,
const NXString relation 
)

Insert an attachment into folder
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
folderfolder
partpart
namename
relationrelation
void NXOpen::Features::ShipDesign::PenetrationUtils::InsertAttachment ( NXOpen::Features::ShipDesign::PenetrationFolder folder,
NXOpen::Part part,
const char *  name,
const char *  relation 
)

Insert an attachment into folder
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
folderfolder
partpart
namename
relationrelation
void NXOpen::Features::ShipDesign::PenetrationUtils::ReloadRequests ( NXOpen::Features::ShipDesign::PenetrationList list)

Set current NXOpen::Features::ShipDesign::PenetrationList
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
listlist
void NXOpen::Features::ShipDesign::PenetrationUtils::RemoveAttachment ( NXOpen::Features::ShipDesign::PenetrationFolder folder,
NXOpen::Features::ShipDesign::PenetrationAttachment attachments 
)

Remove an attachment from folder
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
folderfolder
attachmentsattachments
void NXOpen::Features::ShipDesign::PenetrationUtils::RequestCreateCutout ( NXOpen::Features::ShipDesign::PenetrationRequest request)

Create cut out for the request
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestrequest
void NXOpen::Features::ShipDesign::PenetrationUtils::ReviewRequests ( const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests,
const NXString pchReviewDecision,
const NXString pchReviewComments,
const NXString pchDueDate 
)

Review the requests
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestsrequests
pchReviewDecisionpchreviewdecision
pchReviewCommentspchreviewcomments
pchDueDatepchduedate
void NXOpen::Features::ShipDesign::PenetrationUtils::ReviewRequests ( const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests,
const char *  pchReviewDecision,
const char *  pchReviewComments,
const char *  pchDueDate 
)

Review the requests
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestsrequests
pchReviewDecisionpchreviewdecision
pchReviewCommentspchreviewcomments
pchDueDatepchduedate
void NXOpen::Features::ShipDesign::PenetrationUtils::SaveRequests ( int  eSaveRequestType,
const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests 
)

Save the requests
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
eSaveRequestTypeesaverequesttype
requestsrequests
void NXOpen::Features::ShipDesign::PenetrationUtils::SendToWorkflowRequests ( const std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests)

Send to Workflow the requests
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
requestsrequests
void NXOpen::Features::ShipDesign::PenetrationUtils::SetContextValues ( NXOpen::Part rootPart,
NXOpen::Part workPart,
NXOpen::View workView,
NXOpen::NXObject workOcc 
)

Set the CONTEXT values
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
rootPartrootpart
workPartworkpart
workViewworkview
workOccworkocc
void NXOpen::Features::ShipDesign::PenetrationUtils::SetCurrentSite ( NXOpen::Features::ShipDesign::PenetrationSite site)

Set current NXOpen::Features::ShipDesign::PenetrationSite
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
sitesite
void NXOpen::Features::ShipDesign::PenetrationUtils::SetRootPart ( NXOpen::Part part)

Make part root part and work part
Created in NX8.5.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
partpart
void NXOpen::Features::ShipDesign::PenetrationUtils::SetWorkingList ( NXOpen::Features::ShipDesign::PenetrationSite site,
NXOpen::Features::ShipDesign::PenetrationList list 
)

Set current NXOpen::Features::ShipDesign::PenetrationList
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
sitesite
listlist
tag_t NXOpen::Features::ShipDesign::PenetrationUtils::Tag ( ) const

Returns the tag of this object.

void NXOpen::Features::ShipDesign::PenetrationUtils::VerifyPenetrations ( const std::vector< NXOpen::Part * > &  routingPart,
std::vector< NXOpen::Features::ShipDesign::PenetrationUtils::RequestState > &  states,
std::vector< NXOpen::Features::ShipDesign::PenetrationRequest * > &  requests,
std::vector< int > &  reason 
)

Verify penetrations
Created in NX8.0.0.



License requirements : nx_penetration_mgmt ("Penetration Management")

Parameters
routingPartrouting part
statesstates
requestsrequests
reasonreason

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