PeriDyno 1.0.0
Loading...
Searching...
No Matches
dyno::GroupModule Class Reference

#include <GroupModule.h>

Inheritance diagram for dyno::GroupModule:
Collaboration diagram for dyno::GroupModule:

Public Member Functions

 GroupModule ()
 
virtual ~GroupModule ()
 
void pushModule (std::shared_ptr< Module > m)
 
const std::list< Module * > & moduleList () const
 
void setParentNode (Node *node) override
 Set the parent node.
 
- Public Member Functions inherited from dyno::Module
 Module (std::string name="default")
 
 ~Module (void) override
 
bool initialize ()
 
void update ()
 
void setName (std::string name)
 
std::string getName () override
 
NodegetParentNode ()
 
SceneGraphgetSceneGraph ()
 
bool isInitialized ()
 
virtual std::string getModuleType ()
 
bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
 Attach a field to Base.
 
bool isInputComplete ()
 Check the completeness of input fields.
 
bool isOutputCompete ()
 
 DEF_VAR (bool, ForceUpdate, false, "")
 
void setUpdateAlways (bool b)
 Set the update strategy for the module.
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption.
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI.
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description.
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default.
 
bool addField (FieldID name, FBase *data)
 Add a field to Base.
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer.
 
bool findFieldAlias (const FieldID name)
 Find a field by its name.
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions.
 
bool removeField (FBase *data)
 Remove a field by its pointer.
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name.
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name.
 
std::vector< FBase * > & getAllFields ()
 
template<typename T>
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields.
 
std::vector< FieldIDgetFieldAlias (FBase *data)
 
int getFieldAliasCount (FBase *data)
 
void setBlockCoord (float x, float y)
 
float bx ()
 
float by ()
 
bool findInputField (FBase *field)
 
bool addInputField (FBase *field)
 
bool removeInputField (FBase *field)
 
std::vector< FBase * > & getInputFields ()
 
bool findOutputField (FBase *field)
 
bool addOutputField (FBase *field)
 
bool addToOutput (FBase *field)
 
bool removeOutputField (FBase *field)
 
bool removeFromOutput (FBase *field)
 
std::vector< FBase * > & getOutputFields ()
 
bool findParameter (FBase *field)
 
bool addParameter (FBase *field)
 
bool removeParameter (FBase *field)
 
std::vector< FBase * > & getParameters ()
 
- Public Member Functions inherited from dyno::Object
 Object ()
 
virtual ~Object ()
 
ObjectId objectId ()
 

Protected Member Functions

void preprocess () final
 
void updateImpl () override
 
- Protected Member Functions inherited from dyno::Module
virtual bool initializeImpl ()
 
virtual void postprocess ()
 
virtual bool validateInputs ()
 
virtual bool validateOutputs ()
 
virtual bool requireUpdate ()
 
virtual void updateStarted ()
 Two functions called at the beginning and end of update() used for debug.
 
virtual void updateEnded ()
 

Private Member Functions

void reconstructPipeline ()
 

Private Attributes

bool mModuleUpdated = false
 
std::map< ObjectId, std::shared_ptr< Module > > mModuleMap
 
std::list< Module * > mModuleList
 
std::list< std::shared_ptr< Module > > mPersistentModule
 

Additional Inherited Members

- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 
- Static Public Member Functions inherited from dyno::Object
static bool registerClass (ClassInfo *ci)
 
static ObjectcreateObject (std::string name)
 
static std::map< std::string, ClassInfo * > * getClassMap ()
 
static ObjectId baseId ()
 Base Id.
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Detailed Description

Definition at line 20 of file GroupModule.h.

Constructor & Destructor Documentation

◆ GroupModule()

dyno::GroupModule::GroupModule ( )

Definition at line 10 of file GroupModule.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~GroupModule()

dyno::GroupModule::~GroupModule ( )
virtual

Definition at line 15 of file GroupModule.cpp.

Member Function Documentation

◆ moduleList()

const std::list< Module * > & dyno::GroupModule::moduleList ( ) const
inline

Definition at line 28 of file GroupModule.h.

◆ preprocess()

void dyno::GroupModule::preprocess ( )
finalprotectedvirtual

Reimplemented from dyno::Module.

Definition at line 43 of file GroupModule.cpp.

Here is the call graph for this function:

◆ pushModule()

void dyno::GroupModule::pushModule ( std::shared_ptr< Module > m)

Definition at line 19 of file GroupModule.cpp.

Here is the caller graph for this function:

◆ reconstructPipeline()

void dyno::GroupModule::reconstructPipeline ( )
private

Definition at line 58 of file GroupModule.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setParentNode()

void dyno::GroupModule::setParentNode ( Node * node)
overridevirtual

Set the parent node.

Reimplemented from dyno::Module.

Definition at line 29 of file GroupModule.cpp.

Here is the call graph for this function:

◆ updateImpl()

void dyno::GroupModule::updateImpl ( )
overrideprotectedvirtual

Reimplemented from dyno::Module.

Reimplemented in dyno::SemiAnalyticalIncompressibleFluidModel< TDataType >.

Definition at line 51 of file GroupModule.cpp.

Member Data Documentation

◆ mModuleList

std::list<Module*> dyno::GroupModule::mModuleList
private

Definition at line 42 of file GroupModule.h.

◆ mModuleMap

std::map<ObjectId, std::shared_ptr<Module> > dyno::GroupModule::mModuleMap
private

Definition at line 41 of file GroupModule.h.

◆ mModuleUpdated

bool dyno::GroupModule::mModuleUpdated = false
private

Definition at line 39 of file GroupModule.h.

◆ mPersistentModule

std::list<std::shared_ptr<Module> > dyno::GroupModule::mPersistentModule
private

Definition at line 44 of file GroupModule.h.


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