HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_RelationshipSink.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  */
7 
8 #ifndef __SIM_RelationshipSink_h__
9 #define __SIM_RelationshipSink_h__
10 
11 #include "SIM_API.h"
12 #include "SIM_RelationshipData.h"
13 
14 /// This class defines a sink relationship between objects. Sink
15 /// relationships are useful for solvers that destroy some physical
16 /// entity as part of the solve process. An example of this would be
17 /// the fluid solver which may use another DOP object as a fluid sink
18 /// to destroy fluid.
20 {
21 protected:
22  explicit SIM_RelationshipSink(const SIM_DataFactory *factory);
23  virtual ~SIM_RelationshipSink();
24 
25 private:
26  static const SIM_DopDescription *getSinkDopDescription();
27 
31  "Sink Relationship",
32  getSinkDopDescription());
33 };
34 
35 #endif
36 
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
#define DECLARE_DATAFACTORY(DataClass, SuperClass, Description, DopParms)
Definition: SIM_DataUtils.h:58
#define SIM_API
Definition: SIM_API.h:10