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

Represents a collection of NXOpen::Scalar objects. More...

Inheritance diagram for NXOpen::ScalarCollection:
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::ScalarCreateScalar (double value, NXOpen::Scalar::DimensionalityType dimensionality, NXOpen::SmartObject::UpdateOption update)
 Creates a scalar without parameters. More...
 
NXOpen::ScalarCreateScalar (NXOpen::Scalar *scalarExtract, NXOpen::Scalar *scalarOptional, NXOpen::Scalar::DimensionalityType dimensionality, NXOpen::SmartObject::UpdateOption update)
 Creates a scalar via an existing scalar and an optional scalar. More...
 
NXOpen::ScalarCreateScalarExpression (NXOpen::Expression *expression, NXOpen::Scalar::DimensionalityType dimensionality, NXOpen::SmartObject::UpdateOption update)
 Creates a scalar using an expression. More...
 
NXOpen::ScalarCreateScalarReciprocalValue (NXOpen::Scalar *scalar, NXOpen::Scalar::DimensionalityType dimensionality, NXOpen::SmartObject::UpdateOption update)
 Creates a scalar whose value is a reciprocal of another scalar. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Scalar objects.

Iterating this collection only returns live uncondemned objects contained in the owning part of the collection. Note that NXOpen::Scalar is a smart object and many smart objects are condemned as they only exist to support other objects and are not displayed. Condemned objects will be deleted when their references go away.
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX3.0.0.

Member Function Documentation

iterator NXOpen::ScalarCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Scalar* NXOpen::ScalarCollection::CreateScalar ( double  value,
NXOpen::Scalar::DimensionalityType  dimensionality,
NXOpen::SmartObject::UpdateOption  update 
)

Creates a scalar without parameters.

Returns

Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
Parameters
valuevalue
dimensionalitydimensionality
updateupdate
NXOpen::Scalar* NXOpen::ScalarCollection::CreateScalar ( NXOpen::Scalar scalarExtract,
NXOpen::Scalar scalarOptional,
NXOpen::Scalar::DimensionalityType  dimensionality,
NXOpen::SmartObject::UpdateOption  update 
)

Creates a scalar via an existing scalar and an optional scalar.

Returns

Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
Parameters
scalarExtractscalar extract
scalarOptionalscalar optional
dimensionalitydimensionality
updateupdate
NXOpen::Scalar* NXOpen::ScalarCollection::CreateScalarExpression ( NXOpen::Expression expression,
NXOpen::Scalar::DimensionalityType  dimensionality,
NXOpen::SmartObject::UpdateOption  update 
)

Creates a scalar using an expression.

Returns

Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
Parameters
expressionexpression
dimensionalitydimensionality
updateupdate
NXOpen::Scalar* NXOpen::ScalarCollection::CreateScalarReciprocalValue ( NXOpen::Scalar scalar,
NXOpen::Scalar::DimensionalityType  dimensionality,
NXOpen::SmartObject::UpdateOption  update 
)

Creates a scalar whose value is a reciprocal of another scalar.

Returns

Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
Parameters
scalarscalar
dimensionalitydimensionality
updateupdate
iterator NXOpen::ScalarCollection::end ( )

Returns an iterator addressing one past the last element.

tag_t NXOpen::ScalarCollection::Tag ( ) const

Returns the tag of this object.


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