#include <FBase.h>

Inheritance diagram for FBase:

[legend]

Collaboration diagram for FBase:

[legend]

Public Member Functions
	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)

OBase *	parent ()

bool	isDerived ()

bool	isAutoDestroyable ()

void	setAutoDestroy (bool autoDestroy)

void	setDerived (bool derived)

uint	sizeOfSinks ()

std::vector< FBase * > &	getSinks ()

bool	isModified ()

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 std::string	serialize ()

virtual bool	deserialize (const std::string &str)

FBase *	getTopField ()

FBase *	getSource ()

FBase *	promoteOuput ()
	Display a state field as an ouput field.

FBase *	promoteInput ()
	Display a state field as an input field.

FBase *	demoteOuput ()
	Hide a state field from outputs.

FBase *	demoteInput ()
	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)

Protected Member Functions
void	setSource (FBase *source)

void	addSink (FBase *f)

bool	removeSink (FBase *f)

bool	connectField (FBase *dst)

bool	disconnectField (FBase *dst)

Protected Attributes
FieldTypeEnum	m_fType = FieldTypeEnum::Param

Private Attributes
std::string	m_name

std::string	m_description

bool	m_optional = false

bool	m_autoDestroyable = true

bool	m_derived = false

float	m_min = -FLT_MAX

float	m_max = FLT_MAX

OBase *	mOwner = nullptr

FBase *	mSource = nullptr

std::vector< FBase * >	mSinks

TimeStamp	mTickTime

TimeStamp	mTackTime

std::vector< std::shared_ptr< FCallBackFunc > >	mCallbackFunc

Detailed Description

Definition at line 43 of file FBase.h.

Constructor & Destructor Documentation

◆ FBase() [1/2]

dyno::FBase::FBase ( )

inline

Definition at line 46 of file FBase.h.

◆ FBase() [2/2]

dyno::FBase::FBase	(	std::string	name,
		std::string	description,
		FieldTypeEnum	type = FieldTypeEnum::Param,
		OBase *	parent = nullptr )

Definition at line 272 of file FBase.cpp.

◆ ~FBase()

dyno::FBase::~FBase ( )

virtual

Definition at line 282 of file FBase.cpp.

Member Function Documentation

◆ addSink()

void dyno::FBase::addSink ( FBase * f )

protected

Definition at line 105 of file FBase.cpp.

◆ attach()

void dyno::FBase::attach ( std::shared_ptr< FCallBackFunc > func )

Definition at line 222 of file FBase.cpp.

◆ connect()

virtual bool dyno::FBase::connect ( FBase * dst )

pure virtual

◆ connectField()

bool dyno::FBase::connectField ( FBase * dst )

protected

Definition at line 165 of file FBase.cpp.

◆ demoteInput()

FBase * dyno::FBase::demoteInput ( )

Hide a state field from inputs.

Returns: state field

Definition at line 93 of file FBase.cpp.

◆ demoteOuput()

FBase * dyno::FBase::demoteOuput ( )

Hide a state field from outputs.

Returns: state field

Definition at line 81 of file FBase.cpp.

◆ deserialize()

virtual bool dyno::FBase::deserialize ( const std::string & str )

inlinevirtual

Definition at line 95 of file FBase.h.

◆ detach()

void dyno::FBase::detach ( std::shared_ptr< FCallBackFunc > func )

Definition at line 230 of file FBase.cpp.

◆ disconnect()

bool dyno::FBase::disconnect ( FBase * dst )

virtual

Definition at line 191 of file FBase.cpp.

◆ disconnectField()

bool dyno::FBase::disconnectField ( FBase * dst )

protected

Definition at line 186 of file FBase.cpp.

◆ getClassName()

virtual const std::string dyno::FBase::getClassName ( )

inlinevirtual

Definition at line 52 of file FBase.h.

◆ getDescription()

std::string dyno::FBase::getDescription ( )

inline

Definition at line 55 of file FBase.h.

◆ getDeviceType()

virtual DeviceType dyno::FBase::getDeviceType ( )

inlinevirtual

Definition at line 56 of file FBase.h.

◆ getFieldType()

FieldTypeEnum dyno::FBase::getFieldType ( )

Definition at line 300 of file FBase.cpp.

◆ getMax()

float dyno::FBase::getMax ( )

inline

Definition at line 84 of file FBase.h.

◆ getMin()

float dyno::FBase::getMin ( )

inline

Definition at line 81 of file FBase.h.

◆ getObjectName()

std::string dyno::FBase::getObjectName ( )

inline

Definition at line 54 of file FBase.h.

◆ getSinks()

std::vector< FBase * > & dyno::FBase::getSinks ( )

inline

Definition at line 71 of file FBase.h.

◆ getSource()

FBase * dyno::FBase::getSource ( )

Definition at line 52 of file FBase.cpp.

◆ getTemplateName()

virtual const std::string dyno::FBase::getTemplateName ( )

inlinevirtual

Definition at line 51 of file FBase.h.

◆ getTopField()

FBase * dyno::FBase::getTopField ( )

Definition at line 196 of file FBase.cpp.

◆ isAutoDestroyable()

bool dyno::FBase::isAutoDestroyable ( )

Definition at line 150 of file FBase.cpp.

◆ isDerived()

bool dyno::FBase::isDerived ( )

Definition at line 145 of file FBase.cpp.

◆ isEmpty()

virtual bool dyno::FBase::isEmpty ( )

pure virtual

◆ isModified()

bool dyno::FBase::isModified ( )

Definition at line 243 of file FBase.cpp.

◆ isOptional()

bool dyno::FBase::isOptional ( )

Definition at line 262 of file FBase.cpp.

◆ parent()

OBase * dyno::FBase::parent ( )

Definition at line 41 of file FBase.cpp.

◆ promoteInput()

FBase * dyno::FBase::promoteInput ( )

Display a state field as an input field.

Returns: state field

Definition at line 69 of file FBase.cpp.

◆ promoteOuput()

FBase * dyno::FBase::promoteOuput ( )

Display a state field as an ouput field.

Returns: state field

Definition at line 57 of file FBase.cpp.

◆ removeSink()

bool dyno::FBase::removeSink ( FBase * f )

protected

Definition at line 124 of file FBase.cpp.

◆ serialize()

virtual std::string dyno::FBase::serialize ( )

inlinevirtual

Definition at line 94 of file FBase.h.

◆ setAutoDestroy()

void dyno::FBase::setAutoDestroy ( bool autoDestroy )

Definition at line 155 of file FBase.cpp.

◆ setDerived()

void dyno::FBase::setDerived ( bool derived )

Definition at line 160 of file FBase.cpp.

◆ setDescription()

void dyno::FBase::setDescription ( std::string description )

inline

Definition at line 59 of file FBase.h.

◆ setMax()

void dyno::FBase::setMax ( float max_val )

inline

Definition at line 85 of file FBase.h.

◆ setMin()

void dyno::FBase::setMin ( float min_val )

inline

Definition at line 82 of file FBase.h.

◆ setObjectName()

void dyno::FBase::setObjectName ( std::string name )

inline

Definition at line 58 of file FBase.h.

◆ setParent()

void dyno::FBase::setParent ( OBase * owner )

Definition at line 36 of file FBase.cpp.

◆ setRange()

void dyno::FBase::setRange	(	float	min_val,
		float	max_val )

inline

Definition at line 87 of file FBase.h.

◆ setSource()

void dyno::FBase::setSource ( FBase * source )

protected

Definition at line 46 of file FBase.cpp.

◆ size()

virtual uint dyno::FBase::size ( )

pure virtual

◆ sizeOfSinks()

uint dyno::FBase::sizeOfSinks ( )

inline

Definition at line 70 of file FBase.h.

◆ tack()

void dyno::FBase::tack ( )

Definition at line 257 of file FBase.cpp.

◆ tagOptional()

void dyno::FBase::tagOptional ( bool optional )

Definition at line 267 of file FBase.cpp.

◆ tick()

void dyno::FBase::tick ( )

Definition at line 250 of file FBase.cpp.

◆ update()

void dyno::FBase::update ( )

virtual

Definition at line 201 of file FBase.cpp.

Member Data Documentation

◆ m_autoDestroyable

bool dyno::FBase::m_autoDestroyable = true

private

Definition at line 152 of file FBase.h.

◆ m_derived

bool dyno::FBase::m_derived = false

private

Definition at line 153 of file FBase.h.

◆ m_description

std::string dyno::FBase::m_description

private

Definition at line 148 of file FBase.h.

◆ m_fType

FieldTypeEnum dyno::FBase::m_fType = FieldTypeEnum::Param

protected

Definition at line 144 of file FBase.h.

◆ m_max

float dyno::FBase::m_max = FLT_MAX

private

Definition at line 156 of file FBase.h.

◆ m_min

float dyno::FBase::m_min = -FLT_MAX

private

Definition at line 155 of file FBase.h.

◆ m_name

std::string dyno::FBase::m_name

private

Definition at line 147 of file FBase.h.

◆ m_optional

bool dyno::FBase::m_optional = false

private

Definition at line 150 of file FBase.h.

◆ mCallbackFunc

std::vector<std::shared_ptr<FCallBackFunc> > dyno::FBase::mCallbackFunc

private

Definition at line 167 of file FBase.h.

◆ mOwner

OBase* dyno::FBase::mOwner = nullptr

private

Definition at line 158 of file FBase.h.

◆ mSinks

std::vector<FBase*> dyno::FBase::mSinks

private

Definition at line 162 of file FBase.h.

◆ mSource

FBase* dyno::FBase::mSource = nullptr

private

Definition at line 160 of file FBase.h.

◆ mTackTime

TimeStamp dyno::FBase::mTackTime

private

Definition at line 165 of file FBase.h.

◆ mTickTime

TimeStamp dyno::FBase::mTickTime

private

Definition at line 164 of file FBase.h.

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

D:/Peridyno/peridyno/src/Framework/FBase.h
D:/Peridyno/peridyno/src/Framework/FBase.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FBase() [1/2]

◆ FBase() [2/2]

◆ ~FBase()

Member Function Documentation

◆ addSink()

◆ attach()

◆ connect()

◆ connectField()

◆ demoteInput()

◆ demoteOuput()

◆ deserialize()

◆ detach()

◆ disconnect()

◆ disconnectField()

◆ getClassName()

◆ getDescription()

◆ getDeviceType()

◆ getFieldType()

◆ getMax()

◆ getMin()

◆ getObjectName()

◆ getSinks()

◆ getSource()

◆ getTemplateName()

◆ getTopField()

◆ isAutoDestroyable()

◆ isDerived()

◆ isEmpty()

◆ isModified()

◆ isOptional()

◆ parent()

◆ promoteInput()

◆ promoteOuput()

◆ removeSink()

◆ serialize()

◆ setAutoDestroy()

◆ setDerived()

◆ setDescription()

◆ setMax()

◆ setMin()

◆ setObjectName()

◆ setParent()

◆ setRange()

◆ setSource()

◆ size()

◆ sizeOfSinks()

◆ tack()

◆ tagOptional()

◆ tick()

◆ update()

Member Data Documentation

◆ m_autoDestroyable

◆ m_derived

◆ m_description

◆ m_fType

◆ m_max

◆ m_min

◆ m_name

◆ m_optional

◆ mCallbackFunc

◆ mOwner

◆ mSinks

◆ mSource

◆ mTackTime

◆ mTickTime