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

Provides methods for managing fluid domainsNXOpen::CAE::FluidDomainRecipe in a fem part. More...

Inheritance diagram for NXOpen::CAE::FluidDomainCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::CAE::FluidDomainBuilderCreateBuilder (NXOpen::CAE::FluidDomainRecipe *recipe)
 Creates a fluid domain recipe builder. More...
 
void DeleteRecipe (NXOpen::CAE::FluidDomainRecipe *recipe)
 Deletes a fluid domain recipe
Created in NX11.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::FluidDomainRecipeFind (const NXString &journalIdentifier)
 Finds the CAE::FluidDomainRecipe with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::FluidDomainRecipeFind (const char *journalIdentifier)
 Finds the CAE::FluidDomainRecipe with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::FluidDomainRecipeFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::CAE::FluidDomainRecipe with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::FluidDomainRecipeFindObject (const char *journalIdentifier)
 Finds the NXOpen::CAE::FluidDomainRecipe with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::FluidDomainRecipeFindRecipeFromFluidBody (NXOpen::CAE::CAEBody *fluidBody)
 Finds the fluid domain recipe from which the fluid body was gerenared. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UpdateAll ()
 Updates all fluid domain recipes. More...
 
void UpdateRecipe (NXOpen::CAE::FluidDomainRecipe *recipe)
 Updates a fluid domain recipe. More...
 

Detailed Description

Provides methods for managing fluid domainsNXOpen::CAE::FluidDomainRecipe in a fem part.


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

Created in NX7.5.2.

Member Function Documentation

iterator NXOpen::CAE::FluidDomainCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::FluidDomainBuilder* NXOpen::CAE::FluidDomainCollection::CreateBuilder ( NXOpen::CAE::FluidDomainRecipe recipe)

Creates a fluid domain recipe builder.

Returns
FluidDomain Builder
Created in NX7.5.2.

License requirements : nx_adv_fluid_mod ("NX Advanced Fluid Modeling - Basic") OR sc_acou_meshing (" SC Acoustic Meshing")
Parameters
recipeFluidDomainRecipe to be edited, if NULL then create a new one
void NXOpen::CAE::FluidDomainCollection::DeleteRecipe ( NXOpen::CAE::FluidDomainRecipe recipe)

Deletes a fluid domain recipe
Created in NX11.0.0.



License requirements : nx_adv_fluid_mod ("NX Advanced Fluid Modeling - Basic") OR sc_acou_meshing (" SC Acoustic Meshing")

Parameters
recipeFluidDomainRecipe to be deleted
iterator NXOpen::CAE::FluidDomainCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::FluidDomainRecipe* NXOpen::CAE::FluidDomainCollection::Find ( const NXString journalIdentifier)

Finds the CAE::FluidDomainRecipe with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when Find is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
fluid domain with this identifier
Created in NX11.0.0.

License requirements : None
Parameters
journalIdentifierFluidDomainRecipe name
NXOpen::CAE::FluidDomainRecipe* NXOpen::CAE::FluidDomainCollection::Find ( const char *  journalIdentifier)

Finds the CAE::FluidDomainRecipe with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when Find is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
fluid domain with this identifier
Created in NX11.0.0.

License requirements : None
Parameters
journalIdentifierFluidDomainRecipe name
NXOpen::CAE::FluidDomainRecipe* NXOpen::CAE::FluidDomainCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::CAE::FluidDomainRecipe with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
fluid domain with this identifier
Created in NX7.5.2.

License requirements : None
Parameters
journalIdentifierFluidDomainRecipe name
NXOpen::CAE::FluidDomainRecipe* NXOpen::CAE::FluidDomainCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::CAE::FluidDomainRecipe with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
fluid domain with this identifier
Created in NX7.5.2.

License requirements : None
Parameters
journalIdentifierFluidDomainRecipe name
NXOpen::CAE::FluidDomainRecipe* NXOpen::CAE::FluidDomainCollection::FindRecipeFromFluidBody ( NXOpen::CAE::CAEBody fluidBody)

Finds the fluid domain recipe from which the fluid body was gerenared.

Returns
FluidDomainRecipe from which the CAEBody was gererated
Created in NX11.0.2.

License requirements : None
Parameters
fluidBodyCAEBody for which to look for the generating FluidDomainRecipe
tag_t NXOpen::CAE::FluidDomainCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::CAE::FluidDomainCollection::UpdateAll ( )

Updates all fluid domain recipes.


Created in NX7.5.2.

License requirements : nx_adv_fluid_mod ("NX Advanced Fluid Modeling - Basic") OR sc_acou_meshing (" SC Acoustic Meshing")

void NXOpen::CAE::FluidDomainCollection::UpdateRecipe ( NXOpen::CAE::FluidDomainRecipe recipe)

Updates a fluid domain recipe.


Created in NX7.5.2.

License requirements : nx_adv_fluid_mod ("NX Advanced Fluid Modeling - Basic") OR sc_acou_meshing (" SC Acoustic Meshing")

Parameters
recipeFluidDomainRecipe to be updated

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