sf::CustomFields Class Reference

#include <CustomFields.h>

Inheritance diagram for sf::CustomFields:

Collaboration diagram for sf::CustomFields:

Public Member Functions
	CustomFields (TPartInspection *pi, const std::string &prefix, id_type id_offset, id_type id_range)
	~CustomFields () override
bool	SetExport (bool exported)
bool	IsExported () const
bool	IsComplete () const
void	SetComplete (bool yn)
int	GetCount () const
void	Swap (int index1, int index2)
void	Add ()
void	Add (const std::string &name, const std::string &setup)
void	Clear ()
std::string	GetName (int index) const
std::string	GetSetup (int index) const
void	ReadWriteConfig (IniProfile *ini, bool rd)
void	ReadWriteConfig (bool rd)
bool	ReadWriteValues (bool rd)
void	SetDefaults ()
bool	IsDirty () const
void	SetDirty (bool dirty)
void	GetStrings (KeyValues &list)
void	SetStrings (const KeyValues &list)
Public Member Functions inherited from sf::VariableHandler
virtual	~VariableHandler ()
	Destructor clears the link with variable instances so no errors occur when the link is destructed before the variable is.

Protected Member Functions
void	variableEventHandler (EEvent event, const Variable &caller, Variable &link, bool same_inst) override
	Pure virtual function which must be implemented when used in a polymorphic setting.
bool	Sustain (const timespec &)

Additional Inherited Members
Public Types inherited from sf::VariableTypes
enum	EEvent : int {   veConvert = 64000 , veNewId = -32000 , veUserGlobal , veFirstLocal = 0 ,   veFlagsChange = 1 , veValueChange = 2 , veInvalid = 3 , veConverted = 4 ,   veUserLocal = 5 , veFirstPrivate = 16000 , veIdChanged = 16001 , veDesiredId = 16002 ,   veRemove = 16003 , veGetOwner = 16004 , veLostOwner = 16005 , veLinked = 16006 ,   veUnlinked = 16007 , veSetup = 16008 , veUserPrivate = 16009 }
	Events send to the handler set with sf::Variable::setHandler. More...
enum	EField : int {   vfId = 0 , vfName , vfUnit , vfFlags ,   vfDescription , vfType , vfConversionType , vfRound ,   vfDefault , vfMinimum , vfMaximum , vfFirstState }
	Enumeration of the order of fields in the setup string. More...
enum	EFlag : flags_type {   flgReadonly = 1 << 0 , flgArchive = 1 << 1 , flgShare = 1 << 2 , flgLink = 1 << 3 ,   flgFunction = 1 << 4 , flgParameter = 1 << 5 , flgHidden = 1 << 6 , flgExport = 1 << 7 ,   flgWriteable = 1 << 8 }
	Enumeration type for specifying flags. More...
enum	EStringType : int {   stNormal = 0 , stMulti , stPath , stDirectory ,   stFilename , stSubdirectory }
	Enumeration of string types used for filtering. More...
typedef TVector< Variable * >	PtrVector
	Vector for pointers to variables.
typedef TVector< Variable >	Vector
	Vector for instances of variables.
typedef TVector< VariableReference * >	ReferenceVector
	Types for internal use.
Public Types inherited from sf::InformationTypes
typedef unsigned long long	id_type
	Type used for the identifying integer (64-bits).
typedef int32_t	flags_type
	Type used for the flag integer.
typedef size_t	size_type
	Type used for size of vectors.
typedef ssize_t	ssize_type
	Same as size_type but a signed version.
typedef uintptr_t	data_type
	Type used for containing a single data element which is the largest integer.
typedef intptr_t	sdata_type
	Type used for containing a single data element which is the largest signed integer.
typedef TVector< id_type >	IdVector
	Vector for lists of information ID's.
typedef TVector< InformationBase * >	Vector
	Vector for containing different information base derived classes.
Static Public Member Functions inherited from sf::InformationTypes
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)), data_type >	toDataType (T value)
	Casts any type to a data_type value.
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)||std::is_reference_v< T >), T >	fromDataType (data_type value)
	Casts a data_type value to a given type. Reference types are also possible since they are the same size as a pointer underwater.
Static Public Attributes inherited from sf::InformationTypes
static constexpr size_t	npos = std::numeric_limits<size_type>::max()
	Unsigned size value indicating not found or no index.

Constructor & Destructor Documentation

CustomFields()

sf::CustomFields::CustomFields	(	TPartInspection *	pi,
		const std::string &	prefix,
		id_type	id_offset,
		id_type	id_range
	)

~CustomFields()

sf::CustomFields::~CustomFields ( )

override

Member Function Documentation

Add() [1/2]

void sf::CustomFields::Add

(

)

Add() [2/2]

void sf::CustomFields::Add	(	const std::string &	name,
		const std::string &	setup
	)

Clear()

void sf::CustomFields::Clear

(

)

GetCount()

int sf::CustomFields::GetCount ( ) const

inline

GetName()

std::string sf::CustomFields::GetName ( int  index ) const

inline

GetSetup()

std::string sf::CustomFields::GetSetup ( int  index ) const

inline

GetStrings()

void sf::CustomFields::GetStrings

(

KeyValues &

list

)

IsComplete()

bool sf::CustomFields::IsComplete ( ) const

inline

IsDirty()

bool sf::CustomFields::IsDirty ( ) const

inline

IsExported()

bool sf::CustomFields::IsExported ( ) const

inline

ReadWriteConfig() [1/2]

void sf::CustomFields::ReadWriteConfig

(

bool

rd

)

ReadWriteConfig() [2/2]

void sf::CustomFields::ReadWriteConfig	(	IniProfile *	ini,
		bool	rd
	)

ReadWriteValues()

bool sf::CustomFields::ReadWriteValues

(

bool

rd

)

SetComplete()

void sf::CustomFields::SetComplete ( bool  yn )

inline

SetDefaults()

void sf::CustomFields::SetDefaults

(

)

SetDirty()

void sf::CustomFields::SetDirty ( bool  dirty )

inline

SetExport()

bool sf::CustomFields::SetExport

(

bool

exported

)

SetStrings()

void sf::CustomFields::SetStrings

(

const KeyValues &

list

)

Sustain()

bool sf::CustomFields::Sustain ( const timespec &  )

protected

Swap()

void sf::CustomFields::Swap	(	int	index1,
		int	index2
	)

variableEventHandler()

void sf::CustomFields::variableEventHandler ( EEvent  event, const Variable &  caller, Variable &  link, bool  same_inst  )

overrideprotectedvirtual

Pure virtual function which must be implemented when used in a polymorphic setting.

Parameters

event	Type of the event
caller	Calling variable instance
link	Linked variable instance
same_inst

Implements sf::VariableHandler.

---

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

• CustomFields.h