PeriDyno 1.2.1
Loading...
Searching...
No Matches
dyno::InstanceBase Class Referenceabstract

#include <FInstance.h>

Inheritance diagram for dyno::InstanceBase:
Collaboration diagram for dyno::InstanceBase:

Public Member Functions

 InstanceBase ()
 
 InstanceBase (std::string name, std::string description, FieldTypeEnum fieldType, OBase *parent)
 
virtual bool canBeConnectedBy (InstanceBase *ins)=0
 
virtual void setObjectPointer (std::shared_ptr< Object > op)=0
 
virtual std::shared_ptr< ObjectobjectPointer ()=0
 
virtual std::shared_ptr< ObjectstandardObjectPointer ()=0
 
- 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 uint size ()=0
 
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 bool isEmpty ()=0
 
virtual void update ()
 
void attach (std::shared_ptr< FCallBackFunc > func)
 
void detach (std::shared_ptr< FCallBackFunc > func)
 

Static Public Member Functions

static const std::string className ()
 

Additional Inherited Members

- 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...
 
- 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

Definition at line 27 of file FInstance.h.

Constructor & Destructor Documentation

◆ InstanceBase() [1/2]

dyno::InstanceBase::InstanceBase ( )
inline

Definition at line 30 of file FInstance.h.

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

◆ InstanceBase() [2/2]

dyno::InstanceBase::InstanceBase ( std::string name,
std::string description,
FieldTypeEnum fieldType,
OBase * parent )
inline

Definition at line 31 of file FInstance.h.

Here is the call graph for this function:

Member Function Documentation

◆ canBeConnectedBy()

virtual bool dyno::InstanceBase::canBeConnectedBy ( InstanceBase * ins)
pure virtual

Implemented in dyno::FInstance< T >, and dyno::FInstances< T >.

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

◆ className()

static const std::string dyno::InstanceBase::className ( )
inlinestatic

Definition at line 40 of file FInstance.h.

Here is the caller graph for this function:

◆ objectPointer()

virtual std::shared_ptr< Object > dyno::InstanceBase::objectPointer ( )
pure virtual

Implemented in dyno::FInstance< T >, and dyno::FInstances< T >.

Here is the caller graph for this function:

◆ setObjectPointer()

virtual void dyno::InstanceBase::setObjectPointer ( std::shared_ptr< Object > op)
pure virtual

Implemented in dyno::FInstance< T >, and dyno::FInstances< T >.

Here is the caller graph for this function:

◆ standardObjectPointer()

virtual std::shared_ptr< Object > dyno::InstanceBase::standardObjectPointer ( )
pure virtual

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