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

bool	disconnect (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 ()

uint	sizeOfValidSources ()

void	requestValidSources (std::vector< FBase * > &src)

FBase *	getSource ()

FBase *	getTopField ()

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 FInputPolicy	inputPolicy ()

virtual std::string	serialize ()

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

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)

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

Pointer of objects.

Definition at line 50 of file FInstance.h.

Member Typedef Documentation

◆ FieldType

template<typename T>

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

Definition at line 54 of file FInstance.h.

◆ VarType

template<typename T>

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

Definition at line 53 of file FInstance.h.

Constructor & Destructor Documentation

◆ FInstance() [1/2]

template<typename T>

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

inline

Definition at line 56 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 58 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 88 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 150 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 102 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 73 of file FInstance.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disconnect()

template<typename T>

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

inlineoverridevirtual

Reimplemented from dyno::FBase.

Definition at line 115 of file FInstance.h.

Here is the call graph for this function:

◆ getClassName()

template<typename T>

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

inlinefinalvirtual

Reimplemented from dyno::FBase.

Definition at line 62 of file FInstance.h.

◆ getData()

template<typename T>

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

inline

Definition at line 125 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 64 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 61 of file FInstance.h.

◆ isEmpty()

template<typename T>

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

inlineoverridevirtual

Implements dyno::FBase.

Definition at line 98 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 135 of file FInstance.h.

◆ setDataPtr()

template<typename T>

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

inline

Definition at line 80 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 143 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 132 of file FInstance.h.

◆ standardObjectPointer()

template<typename T>

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

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 139 of file FInstance.h.

Member Data Documentation

◆ mData

template<typename T>

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

private

Definition at line 163 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()

◆ disconnect()

◆ getClassName()

◆ getData()

◆ getDataPtr()

◆ getTemplateName()

◆ isEmpty()

◆ objectPointer()

◆ setDataPtr()

◆ setObjectPointer()

◆ size()

◆ standardObjectPointer()

Member Data Documentation

◆ mData