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

This is the class handling the attributes of a source used by a load recipe. More...

Inheritance diagram for NXOpen::CAE::SimLoadRecipeSource:
NXOpen::TaggedObject

Public Member Functions

NXOpen::CAE::SimLoadRecipeFunctionAttributesDefaultFunctionAttributes ()
 Returns the default attributes (NXOpen::CAE::SimLoadRecipeFunctionAttributes ) of a NXOpen::CAE::SimLoadRecipeSource which are used to indicate the attributes of the functions in the data source. More...
 
NXString FormatType ()
 Returns the format type of a NXOpen::CAE::SimLoadRecipeSource . More...
 
NXOpen::BasePropertyTableGetPropertyTable ()
 Get the NXOpen::BasePropertyTable of a NXOpen::CAE::SimLoadRecipeSource . More...
 
NXString Path ()
 Returns the path of a NXOpen::CAE::SimLoadRecipeSource . More...
 
NXString ReaderType ()
 Returns the reader type of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetFormatType (const NXString &formatType)
 Sets the format type of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetFormatType (const char *formatType)
 Sets the format type of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetPath (const NXString &path)
 Sets the path of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetPath (const char *path)
 Sets the path of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetReaderType (const NXString &readerType)
 Sets the reader type of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetReaderType (const char *readerType)
 Sets the reader type of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetSourceLabel (const NXString &sourceLabel)
 Sets the label of a NXOpen::CAE::SimLoadRecipeSource . More...
 
void SetSourceLabel (const char *sourceLabel)
 Sets the label of a NXOpen::CAE::SimLoadRecipeSource . More...
 
NXString SourceLabel ()
 Returns the label of a NXOpen::CAE::SimLoadRecipeSource . More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This is the class handling the attributes of a source used by a load recipe.


Use CAE.SimLoadRecipeSourceCollection.Create

Created in NX10.0.0.

Member Function Documentation

NXOpen::CAE::SimLoadRecipeFunctionAttributes* NXOpen::CAE::SimLoadRecipeSource::DefaultFunctionAttributes ( )

Returns the default attributes (NXOpen::CAE::SimLoadRecipeFunctionAttributes ) of a NXOpen::CAE::SimLoadRecipeSource which are used to indicate the attributes of the functions in the data source.

This might return null, which means that the format handler takes care of managing those attributes on its own (this is the case for Test.Lab files).


Created in NX12.0.0.

License requirements : None

NXString NXOpen::CAE::SimLoadRecipeSource::FormatType ( )

Returns the format type of a NXOpen::CAE::SimLoadRecipeSource .

The available format types are declared in datasourcehandlers.xml file located in <NX_install_dir>/UGSTRUCTURES/cae_language directory.

This string correlates to the Name attribute of the FormatHandler elements.
Created in NX10.0.0.

License requirements : None

NXOpen::BasePropertyTable* NXOpen::CAE::SimLoadRecipeSource::GetPropertyTable ( )

Get the NXOpen::BasePropertyTable of a NXOpen::CAE::SimLoadRecipeSource .

NOTE: After changing the properties in the table, Update::DoUpdate should be called.

Returns

Created in NX10.0.0.

License requirements : None
NXString NXOpen::CAE::SimLoadRecipeSource::Path ( )

Returns the path of a NXOpen::CAE::SimLoadRecipeSource .


Created in NX10.0.0.

License requirements : None

NXString NXOpen::CAE::SimLoadRecipeSource::ReaderType ( )

Returns the reader type of a NXOpen::CAE::SimLoadRecipeSource .

The available reader types are declared in datasourcehandlers.xml file located in <NX_install_dir>/UGSTRUCTURES/cae_language directory.

This string correlates to the Type attribute of the FileFormat elements.
Created in NX10.0.0.

License requirements : None

void NXOpen::CAE::SimLoadRecipeSource::SetFormatType ( const NXString formatType)

Sets the format type of a NXOpen::CAE::SimLoadRecipeSource .

The available format types are declared in datasourcehandlers.xml file located in <NX_install_dir>/UGSTRUCTURES/cae_language directory.

This string correlates to the Name attribute of the FormatHandler elements.
Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
formatTypeformattype
void NXOpen::CAE::SimLoadRecipeSource::SetFormatType ( const char *  formatType)

Sets the format type of a NXOpen::CAE::SimLoadRecipeSource .

The available format types are declared in datasourcehandlers.xml file located in <NX_install_dir>/UGSTRUCTURES/cae_language directory.

This string correlates to the Name attribute of the FormatHandler elements.
Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
formatTypeformattype
void NXOpen::CAE::SimLoadRecipeSource::SetPath ( const NXString path)

Sets the path of a NXOpen::CAE::SimLoadRecipeSource .


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
pathpath
void NXOpen::CAE::SimLoadRecipeSource::SetPath ( const char *  path)

Sets the path of a NXOpen::CAE::SimLoadRecipeSource .


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
pathpath
void NXOpen::CAE::SimLoadRecipeSource::SetReaderType ( const NXString readerType)

Sets the reader type of a NXOpen::CAE::SimLoadRecipeSource .

The available reader types are declared in datasourcehandlers.xml file located in <NX_install_dir>/UGSTRUCTURES/cae_language directory.

This string correlates to the Type attribute of the FileFormat elements.
Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
readerTypereadertype
void NXOpen::CAE::SimLoadRecipeSource::SetReaderType ( const char *  readerType)

Sets the reader type of a NXOpen::CAE::SimLoadRecipeSource .

The available reader types are declared in datasourcehandlers.xml file located in <NX_install_dir>/UGSTRUCTURES/cae_language directory.

This string correlates to the Type attribute of the FileFormat elements.
Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
readerTypereadertype
void NXOpen::CAE::SimLoadRecipeSource::SetSourceLabel ( const NXString sourceLabel)

Sets the label of a NXOpen::CAE::SimLoadRecipeSource .


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
sourceLabelsourcelabel
void NXOpen::CAE::SimLoadRecipeSource::SetSourceLabel ( const char *  sourceLabel)

Sets the label of a NXOpen::CAE::SimLoadRecipeSource .


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
sourceLabelsourcelabel
NXString NXOpen::CAE::SimLoadRecipeSource::SourceLabel ( )

Returns the label of a NXOpen::CAE::SimLoadRecipeSource .


Created in NX10.0.0.

License requirements : None


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