Pointer of objects. More...

#include <FInstance.h>

Inheritance diagram for dyno::FInstance< T >:

[legend]

Collaboration diagram for dyno::FInstance< T >:

[legend]

Public Types
typedef T	VarType

typedef FInstance< T >	FieldType

Public Member Functions
	FInstance ()

	FInstance (std::string name, std::string description, FieldTypeEnum fieldType, OBase *parent)

const std::string	getTemplateName () override

const std::string	getClassName () final

std::shared_ptr< T >	getDataPtr ()

std::shared_ptr< T >	constDataPtr ()

void	setDataPtr (std::shared_ptr< T > sPtr)

std::shared_ptr< T >	allocate ()

bool	isEmpty () override

bool	connect (FBase *dst) override

T &	getData ()

uint	size () override

std::shared_ptr< Object >	objectPointer () final

std::shared_ptr< Object >	standardObjectPointer () final

void	setObjectPointer (std::shared_ptr< Object > op) final

bool	canBeConnectedBy (InstanceBase *ins) final

Public Member Functions inherited from dyno::InstanceBase
	InstanceBase ()

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

Public Member Functions inherited from dyno::FBase
	FBase ()

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

virtual	~FBase ()

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	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 void	update ()

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

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

Private Attributes
std::shared_ptr< T >	mData = nullptr

Additional Inherited Members
Static Public Member Functions inherited from dyno::InstanceBase
static const std::string	className ()

Protected Member Functions inherited from dyno::FBase
void	setSource (FBase *source)

void	addSink (FBase *f)

bool	removeSink (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>
class dyno::FInstance< T >

Pointer of objects.

Definition at line 49 of file FInstance.h.

Member Typedef Documentation

◆ FieldType

template<typename T>

typedef FInstance<T> dyno::FInstance< T >::FieldType

Definition at line 53 of file FInstance.h.

◆ VarType

template<typename T>

typedef T dyno::FInstance< T >::VarType

Definition at line 52 of file FInstance.h.

Constructor & Destructor Documentation

◆ FInstance() [1/2]

template<typename T>

dyno::FInstance< T >::FInstance ( )

inline

Definition at line 55 of file FInstance.h.

Here is the call graph for this function:

◆ FInstance() [2/2]

template<typename T>

dyno::FInstance< T >::FInstance	(	std::string	name,
		std::string	description,
		FieldTypeEnum	fieldType,
		OBase *	parent )

inline

Definition at line 57 of file FInstance.h.

Here is the call graph for this function:

Member Function Documentation

◆ allocate()

template<typename T>

std::shared_ptr< T > dyno::FInstance< T >::allocate ( )

inline

Definition at line 87 of file FInstance.h.

Here is the call graph for this function:

◆ canBeConnectedBy()

template<typename T>

bool dyno::FInstance< T >::canBeConnectedBy ( InstanceBase * ins )

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 140 of file FInstance.h.

Here is the call graph for this function:

◆ connect()

template<typename T>

bool dyno::FInstance< T >::connect ( FBase * dst )

inlineoverridevirtual

Implements dyno::FBase.

Definition at line 101 of file FInstance.h.

Here is the call graph for this function:

◆ constDataPtr()

template<typename T>

std::shared_ptr< T > dyno::FInstance< T >::constDataPtr ( )

inline

Definition at line 72 of file FInstance.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassName()

template<typename T>

const std::string dyno::FInstance< T >::getClassName ( )

inlinefinalvirtual

Reimplemented from dyno::FBase.

Definition at line 61 of file FInstance.h.

Here is the call graph for this function:

◆ getData()

template<typename T>

T & dyno::FInstance< T >::getData ( )

inline

Definition at line 115 of file FInstance.h.

Here is the call graph for this function:

◆ getDataPtr()

template<typename T>

std::shared_ptr< T > dyno::FInstance< T >::getDataPtr ( )

inline

Definition at line 63 of file FInstance.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplateName()

template<typename T>

const std::string dyno::FInstance< T >::getTemplateName ( )

inlineoverridevirtual

Reimplemented from dyno::FBase.

Definition at line 60 of file FInstance.h.

◆ isEmpty()

template<typename T>

bool dyno::FInstance< T >::isEmpty ( )

inlineoverridevirtual

Implements dyno::FBase.

Definition at line 97 of file FInstance.h.

Here is the call graph for this function:

◆ objectPointer()

template<typename T>

std::shared_ptr< Object > dyno::FInstance< T >::objectPointer ( )

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 125 of file FInstance.h.

◆ setDataPtr()

template<typename T>

void dyno::FInstance< T >::setDataPtr ( std::shared_ptr< T > sPtr )

inline

Definition at line 79 of file FInstance.h.

Here is the call graph for this function:

◆ setObjectPointer()

template<typename T>

void dyno::FInstance< T >::setObjectPointer ( std::shared_ptr< Object > op )

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 133 of file FInstance.h.

Here is the call graph for this function:

◆ size()

template<typename T>

uint dyno::FInstance< T >::size ( )

inlineoverridevirtual

Implements dyno::FBase.

Definition at line 122 of file FInstance.h.

◆ standardObjectPointer()

template<typename T>

std::shared_ptr< Object > dyno::FInstance< T >::standardObjectPointer ( )

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 129 of file FInstance.h.

Member Data Documentation

◆ mData

template<typename T>

std::shared_ptr<T> dyno::FInstance< T >::mData = nullptr

private

Definition at line 148 of file FInstance.h.

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

D:/Peridyno/peridyno/src/Framework/FInstance.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FieldType

◆ VarType

Constructor & Destructor Documentation

◆ FInstance() [1/2]

◆ FInstance() [2/2]

Member Function Documentation

◆ allocate()

◆ canBeConnectedBy()

◆ connect()

◆ constDataPtr()

◆ getClassName()

◆ getData()

◆ getDataPtr()

◆ getTemplateName()

◆ isEmpty()

◆ objectPointer()

◆ setDataPtr()

◆ setObjectPointer()

◆ size()

◆ standardObjectPointer()

Member Data Documentation

◆ mData