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

Represents a NXOpen::CAE::DurSpecialistBlockLoadEvent builder. More...

Inheritance diagram for NXOpen::CAE::DurSpecialistBlockLoadEventBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PatternType { PatternTypeSwelling, PatternTypeAlternating, PatternTypeFree }
 Represents the pattern of the block load. More...
 

Public Member Functions

NXOpen::CAE::DurSpecialistDataSources::FileFormat DataSourceType ()
 Returns the file type. More...
 
NXString Description ()
 Returns the description. More...
 
NXString GetFileName ()
 Get the file name. More...
 
NXOpen::CAE::DurSpecialistDataSources::UnitSystem GetUnitSystem ()
 Get the unit system. More...
 
NXOpen::CAE::DurSpecialistLoadLengthBuilder * LoadLength ()
 Returns the load length. More...
 
NXOpen::ExpressionLowerValue ()
 Returns the lower value. More...
 
NXOpen::CAE::DurSpecialistEvent::UpdateCriterionType ModeSelection ()
 Returns the selection criterion for update. More...
 
NXString Name ()
 Returns the name. More...
 
NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::PatternType Pattern ()
 Returns the pattern. More...
 
void SetDataSourceType (NXOpen::CAE::DurSpecialistDataSources::FileFormat type)
 Sets the file type. More...
 
void SetDescription (const NXString &description)
 Sets the description. More...
 
void SetDescription (const char *description)
 Sets the description. More...
 
void SetFile (const NXString &fileName, NXOpen::CAE::DurSpecialistDataSources::FileFormat type)
 Set file name and type
Created in NX1847.0.0. More...
 
void SetFile (const char *fileName, NXOpen::CAE::DurSpecialistDataSources::FileFormat type)
 Set file name and type
Created in NX1847.0.0. More...
 
void SetModeSelection (NXOpen::CAE::DurSpecialistEvent::UpdateCriterionType type)
 Sets the selection criterion for update. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetPattern (NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::PatternType type)
 Sets the pattern. More...
 
void SetStartWithLower (bool startWithLower)
 Sets the start with lower value flag. More...
 
void SetSubcase (int subcaseIndex)
 Sets the selected subcase (index starting with 1). More...
 
void SetUnitSystem (NXOpen::CAE::DurSpecialistDataSources::UnitSystem unitSystem)
 Set the unit system. More...
 
bool StartWithLower ()
 Returns the start with lower value flag. More...
 
int Subcase ()
 Returns the selected subcase (index starting with 1). More...
 
NXOpen::ExpressionUpperValue ()
 Returns the upper value. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAE::DurSpecialistBlockLoadEvent builder.


To create a new instance of this class, use NXOpen::CAE::DurSpecialistEventCollection::CreateBlockLoadEventBuilder

Created in NX12.0.0.

Member Enumeration Documentation

Represents the pattern of the block load.

Enumerator
PatternTypeSwelling 

between 0 and value

PatternTypeAlternating 

between value and -value

PatternTypeFree 

between two values

Member Function Documentation

NXOpen::CAE::DurSpecialistDataSources::FileFormat NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::DataSourceType ( )

Returns the file type.


Created in NX1847.0.0.

License requirements : None

NXString NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::Description ( )

Returns the description.


Created in NX1847.0.0.

License requirements : None

NXString NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::GetFileName ( )

Get the file name.

Returns

Created in NX1847.0.0.

License requirements : None
NXOpen::CAE::DurSpecialistDataSources::UnitSystem NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::GetUnitSystem ( )

Get the unit system.

Returns

Created in NX1847.0.0.

License requirements : None
NXOpen::CAE::DurSpecialistLoadLengthBuilder* NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::LoadLength ( )

Returns the load length.


Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::LowerValue ( )

Returns the lower value.


Created in NX12.0.0.

License requirements : None

NXOpen::CAE::DurSpecialistEvent::UpdateCriterionType NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::ModeSelection ( )

Returns the selection criterion for update.


Created in NX12.0.0.

License requirements : None

NXString NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::Name ( )

Returns the name.


Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::PatternType NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::Pattern ( )

Returns the pattern.


Created in NX12.0.0.

License requirements : None

void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetDataSourceType ( NXOpen::CAE::DurSpecialistDataSources::FileFormat  type)

Sets the file type.


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
typetype
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetDescription ( const NXString description)

Sets the description.


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
descriptiondescription
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetDescription ( const char *  description)

Sets the description.


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
descriptiondescription
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetFile ( const NXString fileName,
NXOpen::CAE::DurSpecialistDataSources::FileFormat  type 
)

Set file name and type
Created in NX1847.0.0.



License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
fileNamefilename
typetype
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetFile ( const char *  fileName,
NXOpen::CAE::DurSpecialistDataSources::FileFormat  type 
)

Set file name and type
Created in NX1847.0.0.



License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
fileNamefilename
typetype
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetModeSelection ( NXOpen::CAE::DurSpecialistEvent::UpdateCriterionType  type)

Sets the selection criterion for update.


Created in NX12.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
typetype
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetName ( const NXString name)

Sets the name.


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
namename
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetName ( const char *  name)

Sets the name.


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
namename
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetPattern ( NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::PatternType  type)

Sets the pattern.


Created in NX12.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
typetype
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetStartWithLower ( bool  startWithLower)

Sets the start with lower value flag.


Created in NX12.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
startWithLowerstartwithlower
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetSubcase ( int  subcaseIndex)

Sets the selected subcase (index starting with 1).


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
subcaseIndexstarts with 1
void NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::SetUnitSystem ( NXOpen::CAE::DurSpecialistDataSources::UnitSystem  unitSystem)

Set the unit system.


Created in NX1847.0.0.

License requirements : sc_dur_specialist ("Simcenter Specialist Durability")

Parameters
unitSystemunitsystem
bool NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::StartWithLower ( )

Returns the start with lower value flag.


Created in NX12.0.0.

License requirements : None

int NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::Subcase ( )

Returns the selected subcase (index starting with 1).


Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::CAE::DurSpecialistBlockLoadEventBuilder::UpperValue ( )

Returns the upper value.


Created in NX12.0.0.

License requirements : None


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