PeriDyno 1.2.1
Loading...
Searching...
No Matches
dyno::FArray2D< T, deviceType > Class Template Reference

#include <Field.h>

Inheritance diagram for dyno::FArray2D< T, deviceType >:
Collaboration diagram for dyno::FArray2D< T, deviceType >:

Public Types

typedef T VarType
 
typedef Array2D< T, deviceType > DataType
 
typedef FArray2D< T, deviceType > FieldType
 
- Public Types inherited from dyno::FBase
enum  FInputPolicy { One , Many }
 Field with a policy of FInputPolicy::Many is not allowed to be connected to FInputPolicy::One Field with policy of FInputPolicy::One can either be connected to a field of FInputPolicy::One or FInputPolicy::Many. More...
 

Public Member Functions

 DEFINE_FIELD_FUNC (FieldType, DataType, FArray2D)
 
 ~FArray2D () override
 
uint size () override
 
void resize (uint nx, uint ny)
 
void reset ()
 
void clear ()
 
void assign (const CArray2D< T > &vals)
 
void assign (const DArray2D< T > &vals)
 
bool isEmpty () override
 
- Public Member Functions inherited from dyno::FBase
 FBase ()
 
 FBase (std::string name, std::string description, FieldTypeEnum type=FieldTypeEnum::Param, OBase *parent=nullptr)
 
virtual ~FBase ()
 
virtual const std::string getTemplateName ()
 
virtual const std::string getClassName ()
 
std::string getObjectName ()
 
std::string getDescription ()
 
virtual DeviceType getDeviceType ()
 
void setObjectName (std::string name)
 
void setDescription (std::string description)
 
void setParent (OBase *owner)
 
OBaseparent ()
 
bool isDerived ()
 
bool isAutoDestroyable ()
 
void setAutoDestroy (bool autoDestroy)
 
void setDerived (bool derived)
 
uint sizeOfSinks ()
 
uint sizeOfValidSources ()
 
void requestValidSources (std::vector< FBase * > &src)
 
FBasegetSource ()
 
FBasegetTopField ()
 
std::vector< FBase * > & getSources ()
 
std::vector< FBase * > & getSinks ()
 
bool isModified ()
 
bool isActive ()
 A variable to control the visibility of the field.
 
void setActive (bool b)
 
void tick ()
 
void tack ()
 
bool isOptional ()
 
void tagOptional (bool optional)
 
float getMin ()
 
void setMin (float min_val)
 
float getMax ()
 
void setMax (float max_val)
 
void setRange (float min_val, float max_val)
 
FieldTypeEnum getFieldType ()
 
virtual bool connect (FBase *dst)=0
 
virtual bool disconnect (FBase *dst)
 
virtual FInputPolicy inputPolicy ()
 
virtual std::string serialize ()
 
virtual bool deserialize (const std::string &str)
 
FBasepromoteOuput ()
 Display a state field as an ouput field.
 
FBasepromoteInput ()
 Display a state field as an input field.
 
FBasedemoteOuput ()
 Hide a state field from outputs.
 
FBasedemoteInput ()
 Hide a state field from inputs.
 
virtual void update ()
 
void attach (std::shared_ptr< FCallBackFunc > func)
 
void detach (std::shared_ptr< FCallBackFunc > func)
 

Additional Inherited Members

- Protected Member Functions inherited from dyno::FBase
void setSource (FBase *source)
 
bool addSink (FBase *f)
 
bool removeSink (FBase *f)
 
bool addSource (FBase *f)
 
bool removeSource (FBase *f)
 
bool connectField (FBase *dst)
 
bool disconnectField (FBase *dst)
 
- Protected Attributes inherited from dyno::FBase
FieldTypeEnum m_fType = FieldTypeEnum::Param
 

Detailed Description

template<typename T, DeviceType deviceType>
class dyno::FArray2D< T, deviceType >

Define field for Array2D

Definition at line 291 of file Field.h.

Member Typedef Documentation

◆ DataType

template<typename T, DeviceType deviceType>
typedef Array2D<T, deviceType> dyno::FArray2D< T, deviceType >::DataType

Definition at line 295 of file Field.h.

◆ FieldType

template<typename T, DeviceType deviceType>
typedef FArray2D<T, deviceType> dyno::FArray2D< T, deviceType >::FieldType

Definition at line 296 of file Field.h.

◆ VarType

template<typename T, DeviceType deviceType>
typedef T dyno::FArray2D< T, deviceType >::VarType

Definition at line 294 of file Field.h.

Constructor & Destructor Documentation

◆ ~FArray2D()

template<typename T, DeviceType deviceType>
dyno::FArray2D< T, deviceType >::~FArray2D ( )
override

Definition at line 322 of file Field.h.

Member Function Documentation

◆ assign() [1/2]

template<typename T, DeviceType deviceType>
void dyno::FArray2D< T, deviceType >::assign ( const CArray2D< T > & vals)

Definition at line 343 of file Field.h.

◆ assign() [2/2]

template<typename T, DeviceType deviceType>
void dyno::FArray2D< T, deviceType >::assign ( const DArray2D< T > & vals)

Definition at line 331 of file Field.h.

◆ clear()

template<typename T, DeviceType deviceType>
void dyno::FArray2D< T, deviceType >::clear ( )

Definition at line 367 of file Field.h.

◆ DEFINE_FIELD_FUNC()

template<typename T, DeviceType deviceType>
dyno::FArray2D< T, deviceType >::DEFINE_FIELD_FUNC ( FieldType ,
DataType ,
FArray2D< T, deviceType >  )

◆ isEmpty()

template<typename T, DeviceType deviceType>
bool dyno::FArray2D< T, deviceType >::isEmpty ( )
inlineoverridevirtual

Implements dyno::FBase.

Definition at line 316 of file Field.h.

◆ reset()

template<typename T, DeviceType deviceType>
void dyno::FArray2D< T, deviceType >::reset ( )

Definition at line 355 of file Field.h.

◆ resize()

template<typename T, DeviceType deviceType>
void dyno::FArray2D< T, deviceType >::resize ( uint nx,
uint ny )

Definition at line 379 of file Field.h.

◆ size()

template<typename T, DeviceType deviceType>
uint dyno::FArray2D< T, deviceType >::size ( )
inlineoverridevirtual

Implements dyno::FBase.

Definition at line 302 of file Field.h.


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