HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_QueryOptions Class Reference

#include <SIM_QueryOptions.h>

+ Inheritance diagram for SIM_QueryOptions:

Public Member Functions

 SIM_QueryOptions (const SIM_Data *owner, const SIM_Options *options)
 Constructor which takes a const SIM_Data as our owner. More...
 
 ~SIM_QueryOptions () override
 Destructor for this class. More...
 
- Public Member Functions inherited from SIM_Query
 SIM_Query ()
 Simple constructor. More...
 
 SIM_Query (const SIM_Data *owner)
 Constructor which takes a const SIM_Data as our owner. More...
 
virtual ~SIM_Query ()
 Destructor for this class. More...
 
bool deleteIfDataModified () const
 
int getNumRecordTypes () const
 
const char * getRecordTypeName (int recordtypenum) const
 
int getNumRecords (const char *recordtype) const
 
int getNumFields (const char *recordtype) const
 
const char * getFieldName (const char *recordtype, int fieldnum) const
 
UT_OptionType getFieldType (const char *recordtype, int fieldnum) const
 
UT_OptionType getFieldTypeByName (const char *recordtype, const char *fieldname) const
 
bool getFieldRaw (const char *recordtype, int recordnum, const char *fieldname, UT_OptionEntryPtr &result) const
 
bool getFieldString (const char *recordtype, int recordnum, const char *fieldname, UT_String &result) const
 
bool getFieldString (const char *recordtype, int recordnum, const char *fieldname, UT_StringHolder &result) const
 
bool getFieldFloat (const char *recordtype, int recordnum, const char *fieldname, fpreal &result) const
 
void getAllFieldFloatNames (const char *recordtype, UT_StringArray &names, UT_Array< UT_OptionType > &fieldtypes, UT_IntArray &vectorindices) const
 
void getInfoTree (UT_InfoTree &infotree, const char *recordtype) const
 Fills a UT_InfoTree structure with all our data. More...
 

Protected Member Functions

const SIM_OptionsgetOptions () const
 
int getNumRecordTypesSubclass () const override
 
const char * getRecordTypeNameSubclass (int recordtypenum) const override
 
int getNumRecordsSubclass (const char *recordtype) const override
 
int getNumFieldsSubclass (const char *recordtype) const override
 
const char * getFieldNameSubclass (const char *recordtype, int fieldnum) const override
 
UT_OptionType getFieldTypeSubclass (const char *recordtype, int fieldnum) const override
 
bool getFieldRawSubclass (const char *recordtype, int recordnum, const char *fieldname, UT_OptionEntryPtr &result) const override
 
- Protected Member Functions inherited from SIM_Query
const SIM_DatagetOwner () const
 
virtual bool deleteIfDataModifiedSubclass () const
 

Detailed Description

This class provides an interface between a SIM_Data and the Houdini expression language. It also helps in building the tree view of a simulation.

Definition at line 19 of file SIM_QueryOptions.h.

Constructor & Destructor Documentation

SIM_QueryOptions::SIM_QueryOptions ( const SIM_Data owner,
const SIM_Options options 
)
explicit

Constructor which takes a const SIM_Data as our owner.

SIM_QueryOptions::~SIM_QueryOptions ( )
override

Destructor for this class.

Member Function Documentation

const char* SIM_QueryOptions::getFieldNameSubclass ( const char *  recordtype,
int  fieldnum 
) const
overrideprotectedvirtual

Reimplemented from SIM_Query.

bool SIM_QueryOptions::getFieldRawSubclass ( const char *  recordtype,
int  recordnum,
const char *  fieldname,
UT_OptionEntryPtr result 
) const
overrideprotectedvirtual

Reimplemented from SIM_Query.

UT_OptionType SIM_QueryOptions::getFieldTypeSubclass ( const char *  recordtype,
int  fieldnum 
) const
overrideprotectedvirtual

Reimplemented from SIM_Query.

int SIM_QueryOptions::getNumFieldsSubclass ( const char *  recordtype) const
overrideprotectedvirtual

Reimplemented from SIM_Query.

int SIM_QueryOptions::getNumRecordsSubclass ( const char *  recordtype) const
overrideprotectedvirtual

Reimplemented from SIM_Query.

int SIM_QueryOptions::getNumRecordTypesSubclass ( ) const
overrideprotectedvirtual

Reimplemented from SIM_Query.

const SIM_Options& SIM_QueryOptions::getOptions ( ) const
protected
const char* SIM_QueryOptions::getRecordTypeNameSubclass ( int  recordtypenum) const
overrideprotectedvirtual

Reimplemented from SIM_Query.


The documentation for this class was generated from the following file: