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

Represents an interface needed to be implemented by the application object which wants to establish an external file reference managed in Teamcenter. More...

Inheritance diagram for NXOpen::IExternalFileReferencer:
NXOpen::Diagramming::ReferenceGeometryBuilder NXOpen::Fields::ExternalFileProfileBuilder NXOpen::Fields::TimeSeriesProfileBuilder NXOpen::Motion::AnalyticalContactBuilder NXOpen::Motion::BodyContactLms NXOpen::Motion::BodyContactSphereToCAD NXOpen::Motion::MechatronicsBuilder NXOpen::Motion::RoadBuilder NXOpen::Motion::TirePropertyBasicParameters NXOpen::Motion::TirePropertyCdBuilder NXOpen::Motion::TirePropertyFtBuilder NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder

Public Member Functions

virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const NXString &externalFileSpec)=0
 Establish the external reference to the given file specification. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const char *externalFileSpec)=0
 Establish the external reference to the given file specification. More...
 
virtual NXString GetExternalFileDefinitionKey (NXOpen::ExternalFileReferenceAdapter *adapter)=0
 Gets the file definition to use for external file adapter. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
GetExternalFileReferenceAdapter (int referenceObjectId)=0
 Returns the external file reference object. More...
 
virtual void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter *adapter)=0
 Sets the external file reference object. More...
 

Detailed Description

Represents an interface needed to be implemented by the application object which wants to establish an external file reference managed in Teamcenter.


Created in NX1847.0.0.

Member Function Documentation

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::IExternalFileReferencer::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const NXString externalFileSpec 
)
pure virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implemented in NXOpen::Motion::AnalyticalContactBuilder, NXOpen::Motion::TirePropertyCdBuilder, NXOpen::Fields::ExternalFileProfileBuilder, NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder, NXOpen::Motion::RoadBuilder, NXOpen::Motion::MechatronicsBuilder, NXOpen::Motion::TirePropertyBasicParameters, NXOpen::Motion::BodyContactLms, NXOpen::Motion::BodyContactSphereToCAD, NXOpen::Fields::TimeSeriesProfileBuilder, NXOpen::Motion::TirePropertyFtBuilder, and NXOpen::Diagramming::ReferenceGeometryBuilder.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::IExternalFileReferencer::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const char *  externalFileSpec 
)
pure virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implemented in NXOpen::Motion::AnalyticalContactBuilder, NXOpen::Motion::TirePropertyCdBuilder, NXOpen::Fields::ExternalFileProfileBuilder, NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder, NXOpen::Motion::RoadBuilder, NXOpen::Motion::MechatronicsBuilder, NXOpen::Motion::TirePropertyBasicParameters, NXOpen::Motion::BodyContactLms, NXOpen::Motion::BodyContactSphereToCAD, NXOpen::Fields::TimeSeriesProfileBuilder, NXOpen::Motion::TirePropertyFtBuilder, and NXOpen::Diagramming::ReferenceGeometryBuilder.

virtual NXString NXOpen::IExternalFileReferencer::GetExternalFileDefinitionKey ( NXOpen::ExternalFileReferenceAdapter adapter)
pure virtual
virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter ( int  referenceObjectId)
pure virtual

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references

Implemented in NXOpen::Motion::AnalyticalContactBuilder, NXOpen::Motion::TirePropertyCdBuilder, NXOpen::Fields::ExternalFileProfileBuilder, NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder, NXOpen::Motion::RoadBuilder, NXOpen::Motion::MechatronicsBuilder, NXOpen::Motion::TirePropertyBasicParameters, NXOpen::Motion::BodyContactLms, NXOpen::Motion::BodyContactSphereToCAD, NXOpen::Fields::TimeSeriesProfileBuilder, NXOpen::Motion::TirePropertyFtBuilder, and NXOpen::Diagramming::ReferenceGeometryBuilder.

virtual void NXOpen::IExternalFileReferencer::SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter adapter 
)
pure virtual

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.
Created in NX1847.0.0.

License requirements : None

Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
adapterexternal file reference object

Implemented in NXOpen::Motion::AnalyticalContactBuilder, NXOpen::Motion::TirePropertyCdBuilder, NXOpen::Fields::ExternalFileProfileBuilder, NXOpen::Motion::TirePropertyMFTyreAndMFSwiftBuilder, NXOpen::Motion::RoadBuilder, NXOpen::Motion::MechatronicsBuilder, NXOpen::Motion::TirePropertyBasicParameters, NXOpen::Motion::BodyContactLms, NXOpen::Motion::BodyContactSphereToCAD, NXOpen::Fields::TimeSeriesProfileBuilder, NXOpen::Motion::TirePropertyFtBuilder, and NXOpen::Diagramming::ReferenceGeometryBuilder.


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