#include <FInstance.h>

Inheritance diagram for dyno::FInstances< T >:

[legend]

Collaboration diagram for dyno::FInstances< T >:

[legend]

Public Types
typedef T	VarType

typedef FInstances< 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
	FInstances ()

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

const std::string	getTemplateName () override

const std::string	getClassName () final

std::shared_ptr< T >	constDataPtr (const uint i)

bool	connect (FBase *dst) override
	FInstances cannot be connected to other fields.

bool	disconnect (FBase *dst) override

bool	isEmpty () override

uint	size () override

FInputPolicy	inputPolicy () override

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

std::shared_ptr< Object >	objectPointer () override

std::shared_ptr< Object >	standardObjectPointer () 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 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)

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::FInstances< T >

Definition at line 167 of file FInstance.h.

Member Typedef Documentation

◆ FieldType

template<typename T>

typedef FInstances<T> dyno::FInstances< T >::FieldType

Definition at line 171 of file FInstance.h.

◆ VarType

template<typename T>

typedef T dyno::FInstances< T >::VarType

Definition at line 170 of file FInstance.h.

Constructor & Destructor Documentation

◆ FInstances() [1/2]

template<typename T>

dyno::FInstances< T >::FInstances ( )

inline

Definition at line 173 of file FInstance.h.

Here is the call graph for this function:

◆ FInstances() [2/2]

template<typename T>

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

inline

Definition at line 175 of file FInstance.h.

Here is the call graph for this function:

Member Function Documentation

◆ canBeConnectedBy()

template<typename T>

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

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 217 of file FInstance.h.

Here is the call graph for this function:

◆ connect()

template<typename T>

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

inlineoverridevirtual

FInstances cannot be connected to other fields.

Implements dyno::FBase.

Definition at line 193 of file FInstance.h.

◆ constDataPtr()

template<typename T>

std::shared_ptr< T > dyno::FInstances< T >::constDataPtr ( const uint i )

inline

Definition at line 181 of file FInstance.h.

Here is the call graph for this function:

◆ disconnect()

template<typename T>

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

inlineoverridevirtual

Reimplemented from dyno::FBase.

Definition at line 197 of file FInstance.h.

◆ getClassName()

template<typename T>

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

inlinefinalvirtual

Reimplemented from dyno::FBase.

Definition at line 179 of file FInstance.h.

◆ getTemplateName()

template<typename T>

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

inlineoverridevirtual

Reimplemented from dyno::FBase.

Definition at line 178 of file FInstance.h.

◆ inputPolicy()

template<typename T>

FInputPolicy dyno::FInstances< T >::inputPolicy ( )

inlineoverridevirtual

Reimplemented from dyno::FBase.

Definition at line 208 of file FInstance.h.

◆ isEmpty()

template<typename T>

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

inlineoverridevirtual

Implements dyno::FBase.

Definition at line 201 of file FInstance.h.

Here is the call graph for this function:

◆ objectPointer()

template<typename T>

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

inlineoverridevirtual

Implements dyno::InstanceBase.

Definition at line 211 of file FInstance.h.

◆ setObjectPointer()

template<typename T>

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

inlineoverridevirtual

Implements dyno::InstanceBase.

Definition at line 210 of file FInstance.h.

◆ size()

template<typename T>

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

inlineoverridevirtual

Implements dyno::FBase.

Definition at line 205 of file FInstance.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ standardObjectPointer()

template<typename T>

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

inlinefinalvirtual

Implements dyno::InstanceBase.

Definition at line 213 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

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FieldType

◆ VarType

Constructor & Destructor Documentation

◆ FInstances() [1/2]

◆ FInstances() [2/2]

Member Function Documentation

◆ canBeConnectedBy()

◆ connect()

◆ constDataPtr()

◆ disconnect()

◆ getClassName()

◆ getTemplateName()

◆ inputPolicy()

◆ isEmpty()

◆ objectPointer()

◆ setObjectPointer()

◆ size()

◆ standardObjectPointer()