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

Specialization of a NXOpen::CAE::DataReaderOptionBase to handle enumerated values. More...

Inheritance diagram for NXOpen::CAE::DataReaderOptionEnum:
NXOpen::CAE::DataReaderOptionBase NXOpen::TaggedObject

Public Member Functions

NXString DefaultValue ()
 Returns the default selection for the option
Created in NX1847.0.0. More...
 
NXString GetChoiceByIndex (int choiceIndex)
 Returns the choice with the specified index. More...
 
int NumChoices ()
 Returns the number of choices in the enumeration
Created in NX1847.0.0. More...
 
void SetValue (const NXString &choice)
 Sets the current selected choice
Created in NX1847.0.0. More...
 
void SetValue (const char *choice)
 Sets the current selected choice
Created in NX1847.0.0. More...
 
NXString Value ()
 Returns the current selected choice
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::DataReaderOptionBase
NXString Description ()
 Returns the option description. More...
 
NXString Name ()
 Returns the option name. More...
 
NXOpen::CAE::DataReaderDatabaseOptions::OptionType Type ()
 Returns the option type. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Specialization of a NXOpen::CAE::DataReaderOptionBase to handle enumerated values.

An enumerated value offers a list of choices from which to select from. All choices are exposed as strings.




Created in NX1847.0.0.

Member Function Documentation

NXString NXOpen::CAE::DataReaderOptionEnum::DefaultValue ( )

Returns the default selection for the option
Created in NX1847.0.0.



License requirements : None

NXString NXOpen::CAE::DataReaderOptionEnum::GetChoiceByIndex ( int  choiceIndex)

Returns the choice with the specified index.


Created in NX1847.0.0.

License requirements : None

Parameters
choiceIndexchoiceindex
int NXOpen::CAE::DataReaderOptionEnum::NumChoices ( )

Returns the number of choices in the enumeration
Created in NX1847.0.0.



License requirements : None

void NXOpen::CAE::DataReaderOptionEnum::SetValue ( const NXString choice)

Sets the current selected choice
Created in NX1847.0.0.



License requirements : None

Parameters
choicechoice
void NXOpen::CAE::DataReaderOptionEnum::SetValue ( const char *  choice)

Sets the current selected choice
Created in NX1847.0.0.



License requirements : None

Parameters
choicechoice
NXString NXOpen::CAE::DataReaderOptionEnum::Value ( )

Returns the current selected choice
Created in NX1847.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.