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

#include <OutputModule.h>

Inheritance diagram for dyno::OutputModule:
Collaboration diagram for dyno::OutputModule:

Public Member Functions

 OutputModule ()
 
 ~OutputModule () override
 
 DEF_VAR (FilePath, OutputPath, "", "OutputPath")
 
 DEF_VAR (std::string, Prefix, "", "Prefix of the file name")
 
 DEF_VAR (uint, StartFrame, 0, "Start frame")
 
 DEF_VAR (uint, EndFrame, 9999, "End frame")
 
 DEF_VAR (uint, Stride, 1, "Stride")
 
 DEF_VAR (bool, Reordering, true, "If set true, the output file name will be re-indexed in sequence starting from zero")
 
 DEF_VAR_IN (uint, FrameNumber, "Input FrameNumber")
 
std::string getModuleType () override
 
- 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
 
virtual void setParentNode (Node *node)
 Set the parent node.
 
NodegetParentNode ()
 
SceneGraphgetSceneGraph ()
 
bool isInitialized ()
 
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 updateImpl () final
 
virtual void output ()
 
std::string constructFileName ()
 
- Protected Member Functions inherited from dyno::Module
virtual bool initializeImpl ()
 
virtual void preprocess ()
 
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 ()
 

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 8 of file OutputModule.h.

Constructor & Destructor Documentation

◆ OutputModule()

dyno::OutputModule::OutputModule ( )

Definition at line 5 of file OutputModule.cpp.

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

◆ ~OutputModule()

dyno::OutputModule::~OutputModule ( )
override

Definition at line 17 of file OutputModule.cpp.

Member Function Documentation

◆ constructFileName()

std::string dyno::OutputModule::constructFileName ( )
protected

construct the file name with an index appended at the end

Definition at line 40 of file OutputModule.cpp.

Here is the caller graph for this function:

◆ DEF_VAR() [1/6]

dyno::OutputModule::DEF_VAR ( bool ,
Reordering ,
true ,
"If set true,
the output file name will be re-indexed in sequence starting from zero"  )

◆ DEF_VAR() [2/6]

dyno::OutputModule::DEF_VAR ( FilePath ,
OutputPath ,
"" ,
"OutputPath"  )

◆ DEF_VAR() [3/6]

dyno::OutputModule::DEF_VAR ( std::string ,
Prefix ,
"" ,
"Prefix of the file name"  )

◆ DEF_VAR() [4/6]

dyno::OutputModule::DEF_VAR ( uint ,
EndFrame ,
9999 ,
"End frame"  )

◆ DEF_VAR() [5/6]

dyno::OutputModule::DEF_VAR ( uint ,
StartFrame ,
0 ,
"Start frame"  )

◆ DEF_VAR() [6/6]

dyno::OutputModule::DEF_VAR ( uint ,
Stride ,
1 ,
"Stride"  )

◆ DEF_VAR_IN()

dyno::OutputModule::DEF_VAR_IN ( uint ,
FrameNumber ,
"Input FrameNumber"  )

◆ getModuleType()

std::string dyno::OutputModule::getModuleType ( )
inlineoverridevirtual

Reimplemented from dyno::Module.

Definition at line 27 of file OutputModule.h.

◆ output()

virtual void dyno::OutputModule::output ( )
inlineprotectedvirtual

Reimplemented in dyno::EigenValueWriter< TDataType >, dyno::ParticleWriter< TDataType >, dyno::TetraMeshWriter< TDataType >, and dyno::TriangleMeshWriter< TDataType >.

Definition at line 32 of file OutputModule.h.

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

◆ updateImpl()

void dyno::OutputModule::updateImpl ( )
finalprotectedvirtual

Reimplemented from dyno::Module.

Definition at line 21 of file OutputModule.cpp.

Here is the call graph for this function:

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