SIM_Data.h File Reference

#include "SIM_API.h"
#include <iosfwd>
#include <UT/UT_Guid.h>
#include <UT/UT_IntArray.h>
#include <UT/UT_ValArray.h>
#include <UT/UT_BitArray.h>
#include <UT/UT_StringArray.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_VectorTypes.h>
#include <GU/GU_DetailHandle.h>
#include "SIM_Error.h"
#include "SIM_Time.h"
#include "SIM_DataFactory.h"
#include "SIM_CacheCompression.h"

Include dependency graph for SIM_Data.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	SIM_EachDataCallback
class	SIM_Data

Macros
#define	SIM_DATA_RETURN_EXISTING   0x01
#define	SIM_DATA_CREATE_UNIQUE_NAME   0x02
#define	SIM_DATA_ADOPT_EXISTING_ON_DELETE   0x04

Typedefs
typedef UT_ValArray< SIM_Data * >	SIM_DataArray
	This definition holds on to a collection of SIM_Data pointers. More...
typedef UT_ValArray< const SIM_Data * >	SIM_ConstDataArray
	This definition holds on to a collection of const SIM_Data pointers. More...

Enumerations
enum	SIM_SubdataBehavior { SIM_SUBDATA_REPLACE, SIM_SUBDATA_ADD, SIM_SUBDATA_IGNORE, SIM_SUBDATA_COPYING }

Macro Definition Documentation

#define SIM_DATA_ADOPT_EXISTING_ON_DELETE   0x04

Signifies that if a new sub-data is created to replace existing data, that the existing data should be copied into the new data. If an existing sub-data with the given name is found, but is the wrong data type or the SIM_DATA_RETURN_EXISTING constant is not set, then a new data will be created to replace the existing data. If this constant is not set, the new data uses all default values instead of trying to copy information from the existing data. This constant can be used in the creationflags parameter in the SIM_Data::createNamedSubData() function. This flag is ignored by SIM_Data::setNamedSubData().

Definition at line 110 of file SIM_Data.h.

#define SIM_DATA_CREATE_UNIQUE_NAME   0x02

Signifies that the new data should be given a unique new name. If any data with the same name already exists, instead of overwriting that existing data the data name is modified to create a unique name. The data name has numbers appended to it to create the unique name. If SIM_DATA_RETURN_EXISTING is also set, this flag takes precedence and new name for the new data will be created rather than returning the existing data. This constant can be used in the creationflags parameter in the SIM_Data::createNamedSubData() function or the setflags parameter in SIM_Data::setNamedSubData().

Definition at line 100 of file SIM_Data.h.

#define SIM_DATA_RETURN_EXISTING   0x01

Signifies that an existing non-const sub-data of the parent data can be returned instead of creating new data. This constant can be used in the creationflags parameter in the SIM_Data::createNamedSubData() function. If this value is in the setflags parameter to SIM_Data::setNamedSubData(), and any data with the specified name already exists, it is not deleted and the new data is not attached.

Examples:

DOP/DOP_GroupAndApply.C.

Definition at line 90 of file SIM_Data.h.

Typedef Documentation

typedef UT_ValArray<const SIM_Data *> SIM_ConstDataArray

This definition holds on to a collection of const SIM_Data pointers.

Definition at line 51 of file SIM_Data.h.

typedef UT_ValArray<SIM_Data *> SIM_DataArray

This definition holds on to a collection of SIM_Data pointers.

Definition at line 46 of file SIM_Data.h.

Enumeration Type Documentation

enum SIM_SubdataBehavior

This enumeration provides options on how to deal with subdata when calling makeEqual() or initialize(). The options are to eliminate any existing subdata and replace it with the source subdata; or to leave existing subdata, and copy any source subdata on top; or to leave the existing subdata and not copy over any of the source subdata. For calls to initialize(), where there is no source data, the ignore and add operations have the same behavior. COPYING will not invoke the myOptions initialize from parm on the theory you plan on overwriting this later.

Enumerator
SIM_SUBDATA_REPLACE
SIM_SUBDATA_ADD
SIM_SUBDATA_IGNORE
SIM_SUBDATA_COPYING

Definition at line 121 of file SIM_Data.h.