PeriDyno 0.8.2
Public Types | Public Member Functions | Private Attributes | List of all members
dyno::ParticleWriterABC< TDataType > Class Template Reference

#include <ParticleWriterABC.h>

Inheritance diagram for dyno::ParticleWriterABC< TDataType >:
Inheritance graph
[legend]
Collaboration diagram for dyno::ParticleWriterABC< TDataType >:
Collaboration graph
[legend]

Public Types

typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 

Public Member Functions

 ParticleWriterABC ()
 
virtual ~ParticleWriterABC ()
 
void flush () override
 
 DEF_INSTANCE_IN (PointSet< TDataType >, PointSet, "")
 
 DEF_ARRAY_IN (Real, Color, DeviceType::GPU, "")
 
- Public Member Functions inherited from dyno::OutputModule
 OutputModule ()
 
virtual ~OutputModule ()
 
std::string getModuleType () override
 
virtual void flush ()
 
- Public Member Functions inherited from dyno::Module
 Module (std::string name="default")
 
 ~Module (void) override
 
bool initialize ()
 
void update ()
 
void setName (std::string name)
 
void setParent (Node *node)
 
std::string getName () override
 
NodegetParent ()
 
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. More...
 
bool isInputComplete ()
 Check the completeness of input fields. More...
 
bool isOutputCompete ()
 
 DEF_VAR (bool, ForceUpdate, false, "")
 
void setUpdateAlways (bool b)
 Set the update strategy for the module. More...
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption. More...
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI. More...
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description. More...
 
virtual std::string getName ()
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default. More...
 
bool addField (FieldID name, FBase *data)
 Add a field to Base. More...
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer. More...
 
bool findFieldAlias (const FieldID name)
 Find a field by its name. More...
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions. More...
 
bool removeField (FBase *data)
 Remove a field by its pointer. More...
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name. More...
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name. More...
 
std::vector< FBase * > & getAllFields ()
 
virtual bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true)
 Attach a field to Base. More...
 
template<typename T >
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields. More...
 
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 ()
 

Private Attributes

int m_output_index = 0
 
int time_idx = 0
 

Additional Inherited Members

- 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. More...
 
- Protected Member Functions inherited from dyno::OutputModule
void updateImpl () override
 
 DEF_VAR (std::string, OutputPath, "", "")
 
 DEF_VAR (std::string, Prefix, "", "")
 
 DEF_VAR (unsigned, Start, 1, "FramStep")
 
 DEF_VAR (unsigned, End, 1000, "FramStep")
 
 DEF_VAR (unsigned, FrameStep, 1, "FramStep")
 
- Protected Member Functions inherited from dyno::Module
virtual bool initializeImpl ()
 
virtual void updateImpl ()
 
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. More...
 
virtual void updateEnded ()
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Detailed Description

template<typename TDataType>
class dyno::ParticleWriterABC< TDataType >

Definition at line 24 of file ParticleWriterABC.h.

Member Typedef Documentation

◆ Coord

template<typename TDataType >
typedef TDataType::Coord dyno::ParticleWriterABC< TDataType >::Coord

Definition at line 29 of file ParticleWriterABC.h.

◆ Real

template<typename TDataType >
typedef TDataType::Real dyno::ParticleWriterABC< TDataType >::Real

Definition at line 28 of file ParticleWriterABC.h.

Constructor & Destructor Documentation

◆ ParticleWriterABC()

template<typename TDataType >
dyno::ParticleWriterABC< TDataType >::ParticleWriterABC

Definition at line 19 of file ParticleWriterABC.cpp.

◆ ~ParticleWriterABC()

template<typename TDataType >
dyno::ParticleWriterABC< TDataType >::~ParticleWriterABC
virtual

Definition at line 25 of file ParticleWriterABC.cpp.

Member Function Documentation

◆ DEF_ARRAY_IN()

template<typename TDataType >
dyno::ParticleWriterABC< TDataType >::DEF_ARRAY_IN ( Real  ,
Color  ,
DeviceType::GPU  ,
""   
)

◆ DEF_INSTANCE_IN()

template<typename TDataType >
dyno::ParticleWriterABC< TDataType >::DEF_INSTANCE_IN ( PointSet< TDataType >  ,
PointSet  ,
""   
)

◆ flush()

template<typename TDataType >
void dyno::ParticleWriterABC< TDataType >::flush
overridevirtual

Reimplemented from dyno::OutputModule.

Definition at line 30 of file ParticleWriterABC.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_output_index

template<typename TDataType >
int dyno::ParticleWriterABC< TDataType >::m_output_index = 0
private

Definition at line 41 of file ParticleWriterABC.h.

◆ time_idx

template<typename TDataType >
int dyno::ParticleWriterABC< TDataType >::time_idx = 0
private

Definition at line 42 of file ParticleWriterABC.h.


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