Simple implementation of imeas::INumericConstraints interface. More...

#include <CNumericConstraintsComp.h>

Inheritance diagram for imeas::CNumericConstraintsComp:

Collaboration diagram for imeas::CNumericConstraintsComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from imeas::INumericConstraints
typedef QByteArray	ValueTypeId

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Types inherited from imath::IUnitInfo
enum	UnitType { UT_UNKNOWN , UT_PHYSICAL , UT_TECHNICAL , UT_RELATIVE , UT_COUNTER }
	General type of unit. More...

Public Member Functions
const iprm::IOptionsList &	GetValueListInfo () const override
	Get general information about the "content" of the numeric value.

const imath::IUnitInfo *	GetNumericValueUnitInfo (int index) const override
	Get range of possible numeric values for specified list index.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from imeas::INumericConstraints
Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from imath::IUnitInfo

Protected Member Functions
int	GetUnitType () const override
	Get type of unit.

QString	GetUnitName () const override
	Get name of unit.

double	GetDisplayMultiplicationFactor () const override
	Get multiplication factor used to calculate user input values.

istd::CRange	GetValueRange () const override
	Get range of possible values.

const imath::IDoubleManip &	GetValueManip () const override
	Return number manipulator object for numeric value.

int	GetPrecision () const override
	Get number of digits after point.

int	GetOptionsFlags () const override
	Get constraints flags.

int	GetOptionsCount () const override
	Get number of managed options.

QString	GetOptionName (int index) const override
	Get name of specified option.

QString	GetOptionDescription (int index) const override
	Get human readable description for a option with the index `index`.

QByteArray	GetOptionId (int index) const override
	Get option ID.

bool	IsOptionEnabled (int index) const override
	Return `true` if the option is enabled and can be selected.

void	OnComponentCreated () override

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentDestroyed ()

virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Protected Member Functions inherited from imath::CDoubleManip
	CDoubleManip ()

char	GetPointChar () const
	Get point character.

void	SetPointChar (char pointChar)
	Set point character.

virtual double	GetRounded (const double &value) const
	Get the nearest value rounded used this arithmetik.

virtual bool	IsEqual (const double &value1, const double &value2) const
	Compare two values and check, if there are equal.

virtual bool	IsSmaller (const double &value1, const double &value2) const
	Compare two values and check, if first one is smaller as the second.

virtual bool	IsSmallerEqual (const double &value1, const double &value2) const
	Compare two values and check, if first one is smaller or equal as the second.

virtual double	GetSmallerValue (const double &value) const
	Return biggest value smaller that specified one.

virtual double	GetBiggerValue (const double &value) const
	Return smallest value bigger that specified one.

virtual QString	GetString (const double &value) const
	Get this value as string.

virtual bool	GetParsed (const QString &text, double &result) const
	Get value converted from string.

Protected Member Functions inherited from imath::IDoubleManip
Protected Member Functions inherited from imath::TIValueManip< double >
Protected Member Functions inherited from iprm::IOptionsList

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Types inherited from imath::CDoubleManip
enum	{ PRECISION = 6 }

Protected Types inherited from iprm::IOptionsList
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for control constraints behavior. More...

Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Static Protected Member Functions inherited from iprm::IOptionsList
static int	FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
	Helper function to find the option index by ID.

Detailed Description

Simple implementation of imeas::INumericConstraints interface.

All values use the same units and ranges.

Definition at line 27 of file CNumericConstraintsComp.h.

Member Typedef Documentation

◆ BaseClass

icomp::CComponentBase imeas::CNumericConstraintsComp::BaseClass

Definition at line 35 of file CNumericConstraintsComp.h.

Member Function Documentation

◆ GetDisplayMultiplicationFactor()

double imeas::CNumericConstraintsComp::GetDisplayMultiplicationFactor ( ) const

overrideprotectedvirtual

Get multiplication factor used to calculate user input values.

Implements imath::IUnitInfo.

◆ GetNumericValueUnitInfo()

const imath::IUnitInfo * imeas::CNumericConstraintsComp::GetNumericValueUnitInfo ( int index ) const

overridevirtual

Get range of possible numeric values for specified list index.

Parameters

index index of numeric value.

Implements imeas::INumericConstraints.

◆ GetOptionDescription()

QString imeas::CNumericConstraintsComp::GetOptionDescription ( int index ) const

overrideprotectedvirtual

Get human readable description for a option with the index index.

Implements iprm::IOptionsList.

◆ GetOptionId()

QByteArray imeas::CNumericConstraintsComp::GetOptionId ( int index ) const

overrideprotectedvirtual

Get option ID.

The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.

See also: OptionsFlags

Implements iprm::IOptionsList.

◆ GetOptionName()

QString imeas::CNumericConstraintsComp::GetOptionName ( int index ) const

overrideprotectedvirtual

Get name of specified option.

Implements iprm::IOptionsList.

◆ GetOptionsCount()

int imeas::CNumericConstraintsComp::GetOptionsCount ( ) const

overrideprotectedvirtual

Get number of managed options.

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

int imeas::CNumericConstraintsComp::GetOptionsFlags ( ) const

overrideprotectedvirtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

◆ GetPrecision()

int imeas::CNumericConstraintsComp::GetPrecision ( ) const

overrideprotectedvirtual

Get number of digits after point.

Reimplemented from imath::CDoubleManip.

◆ GetUnitName()

QString imeas::CNumericConstraintsComp::GetUnitName ( ) const

overrideprotectedvirtual

Get name of unit.

Implements imath::IUnitInfo.

◆ GetUnitType()

int imeas::CNumericConstraintsComp::GetUnitType ( ) const

overrideprotectedvirtual

Get type of unit.

Implements imath::IUnitInfo.

◆ GetValueListInfo()

const iprm::IOptionsList & imeas::CNumericConstraintsComp::GetValueListInfo ( ) const

overridevirtual

Get general information about the "content" of the numeric value.

Implements imeas::INumericConstraints.

◆ GetValueManip()

const imath::IDoubleManip & imeas::CNumericConstraintsComp::GetValueManip ( ) const

overrideprotectedvirtual

Return number manipulator object for numeric value.

Implements imath::IUnitInfo.

◆ GetValueRange()

istd::CRange imeas::CNumericConstraintsComp::GetValueRange ( ) const

overrideprotectedvirtual

Get range of possible values.

If invalid range is returned, there is no restrictions.

Implements imath::IUnitInfo.

◆ IsOptionEnabled()

bool imeas::CNumericConstraintsComp::IsOptionEnabled ( int index ) const

overrideprotectedvirtual

Return true if the option is enabled and can be selected.

Implements iprm::IOptionsList.

◆ OnComponentCreated()

void imeas::CNumericConstraintsComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

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

imeas/CNumericConstraintsComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetDisplayMultiplicationFactor()

◆ GetNumericValueUnitInfo()

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ GetPrecision()

◆ GetUnitName()

◆ GetUnitType()

◆ GetValueListInfo()

◆ GetValueManip()

◆ GetValueRange()

◆ IsOptionEnabled()

◆ OnComponentCreated()