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

Provides methods for managing fluid domainsCAE::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.
 
NXOpen::CAE::FluidDomainBuilderCreateBuilder (NXOpen::CAE::FluidDomainRecipe *recipe)
 Creates a fluid domain recipe builder.
 
iterator end ()
 Returns an iterator addressing one past the last element.
 
NXOpen::CAE::FluidDomainRecipeFindObject (const NXString &journalIdentifier)
 Finds the CAE::FluidDomainRecipe with the given identifier as recorded in a journal.
 
NXOpen::CAE::FluidDomainRecipeFindObject (const char *journalIdentifier)
 Finds the CAE::FluidDomainRecipe with the given identifier as recorded in a journal.
 
tag_t Tag () const
 Returns the tag of this object.
 
void UpdateAll ()
 Updates all fluid domain recipes.
 
void UpdateRecipe (NXOpen::CAE::FluidDomainRecipe *recipe)
 Updates a fluid domain recipe.
 

Detailed Description

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


To obtain an instance of this class, refer to 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.

     @return  FluidDomain Builder 


Created in NX7.5.2.

License requirements : nx_adv_fluid_mod ("NX Advanced Fluid Modeling")

Parameters
recipeFluidDomainRecipe to be edited, if NULL then create a new one
iterator NXOpen::CAE::FluidDomainCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::FluidDomainRecipe* NXOpen::CAE::FluidDomainCollection::FindObject ( 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 
   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.  @return  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 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.  @return  fluid domain with this identifier 


Created in NX7.5.2.

License requirements : None

Parameters
journalIdentifierFluidDomainRecipe name
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")

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")

Parameters
recipeFluidDomainRecipe to be deleted

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