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

Represents a NXOpen::SIM::LoadSnapshotBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateSimulationLoadsnapshotBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::SIM::LoadSnapshotBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString ExternalReference ()
 Returns the external reference
Created in NX12.0.2. More...
 
std::vector
< NXOpen::SIM::Snapshot * > 
GetExternalSnapshots ()
 The external snapshots
Created in NX12.0.2. More...
 
NXOpen::SIM::SnapshotGetSnapshot (const NXString &snapshotName, const NXString &setupName)
 Returns the snapshot
More...
 
NXOpen::SIM::SnapshotGetSnapshot (const char *snapshotName, const char *setupName)
 Returns the snapshot
More...
 
bool RunToSimTime ()
 Returns the run to simulation time
Created in NX12.0.0. More...
 
void SetExternalReference (const NXString &reference)
 Sets the external reference
Created in NX12.0.2. More...
 
void SetExternalReference (const char *reference)
 Sets the external reference
Created in NX12.0.2. More...
 
void SetExternalSnapshotSelection (const std::vector< NXOpen::SIM::Snapshot * > &snapshotTags, std::vector< NXString > &targetSetups)
 The external snapshot selection
Created in NX12.0.2. More...
 
void SetRunToSimTime (bool bRunToTime)
 Sets the run to simulation time
Created in NX12.0.0. More...
 
void SetSnapshot (NXOpen::SIM::Snapshot *snapshot)
 Sets the snapshot
Created in NX12.0.2. More...
 
NXOpen::SIM::SnapshotSnapshot ()
 Returns the snapshot
Created in NX12.0.2. 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::SIM::LoadSnapshotBuilder
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateSimulationLoadsnapshotBuilder

Created in NX12.0.0.


Member Function Documentation

NXString NXOpen::SIM::LoadSnapshotBuilder::ExternalReference ( )

Returns the external reference
Created in NX12.0.2.



License requirements : None

std::vector<NXOpen::SIM::Snapshot *> NXOpen::SIM::LoadSnapshotBuilder::GetExternalSnapshots ( )

The external snapshots
Created in NX12.0.2.



License requirements : None

NXOpen::SIM::Snapshot* NXOpen::SIM::LoadSnapshotBuilder::GetSnapshot ( const NXString snapshotName,
const NXString setupName 
)

Returns the snapshot

Deprecated:
Deprecated in NX12.0.2.

Use new version with few arguments instead.


Created in NX12.0.0.

License requirements : None

Parameters
snapshotNamesnapshotname
setupNamesetupname
NXOpen::SIM::Snapshot* NXOpen::SIM::LoadSnapshotBuilder::GetSnapshot ( const char *  snapshotName,
const char *  setupName 
)

Returns the snapshot

Deprecated:
Deprecated in NX12.0.2.

Use new version with few arguments instead.


Created in NX12.0.0.

License requirements : None

Parameters
snapshotNamesnapshotname
setupNamesetupname
bool NXOpen::SIM::LoadSnapshotBuilder::RunToSimTime ( )

Returns the run to simulation time
Created in NX12.0.0.



License requirements : None

void NXOpen::SIM::LoadSnapshotBuilder::SetExternalReference ( const NXString reference)

Sets the external reference
Created in NX12.0.2.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
referencereference
void NXOpen::SIM::LoadSnapshotBuilder::SetExternalReference ( const char *  reference)

Sets the external reference
Created in NX12.0.2.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
referencereference
void NXOpen::SIM::LoadSnapshotBuilder::SetExternalSnapshotSelection ( const std::vector< NXOpen::SIM::Snapshot * > &  snapshotTags,
std::vector< NXString > &  targetSetups 
)

The external snapshot selection
Created in NX12.0.2.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
snapshotTagssnapshottags
targetSetupsThe setup where each snapshot is attached
void NXOpen::SIM::LoadSnapshotBuilder::SetRunToSimTime ( bool  bRunToTime)

Sets the run to simulation time
Created in NX12.0.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
bRunToTimebruntotime
void NXOpen::SIM::LoadSnapshotBuilder::SetSnapshot ( NXOpen::SIM::Snapshot snapshot)

Sets the snapshot
Created in NX12.0.2.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
snapshotsnapshot
NXOpen::SIM::Snapshot* NXOpen::SIM::LoadSnapshotBuilder::Snapshot ( )

Returns the snapshot
Created in NX12.0.2.



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.