iprm::CEnableableParam Class Reference

Basic implementation of IEnableableParam interface. More...

#include <CEnableableParam.h>

Inheritance diagram for iprm::CEnableableParam:

Public Member Functions
	CEnableableParam (bool isEnabled=true)
virtual bool	IsEnabled () const override
	Return true if something is enabled.
virtual bool	IsEnablingAllowed () const override
	Return true if enabling/disabling is allowed.
virtual bool	SetEnabled (bool isEnabled=true) override
	Set the enabled state.
virtual bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) const override
	Make a copy of this object.
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.
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 bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.
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 istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Public Types inherited from iprm::IEnableableParam
enum	ChangeFlags { CF_ENABLED = 0x089347 }
	Change notification flags. More...
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ACF_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 }
	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...
typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap
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 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.

Detailed Description

Basic implementation of IEnableableParam interface.

Definition at line 16 of file CEnableableParam.h.

Constructor & Destructor Documentation

CEnableableParam()

iprm::CEnableableParam::CEnableableParam

(

bool

isEnabled = true

)

Member Function Documentation

CloneMe()

virtual istd::TUniqueInterfacePtr< istd::IChangeable > iprm::CEnableableParam::CloneMe ( istd::IChangeable::CompatibilityMode  mode = istd::IChangeable::CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

Returns

new instance or NULL, if this operation is not supported.

Reimplemented from istd::IChangeable.

Reimplemented in iqtgui::CHierarchicalCommand.

CopyFrom()

virtual bool iprm::CEnableableParam::CopyFrom ( const IChangeable &  object, CompatibilityMode  mode = CM_WITHOUT_REFS  )

overridevirtual

IsEnabled()

virtual bool iprm::CEnableableParam::IsEnabled ( ) const

overridevirtual

Return true if something is enabled.

Returns

true if currently enabled, false if disabled.

if (param.IsEnabled())
{
    // Perform action that requires enabled state
}

See also

SetEnabled, IsEnablingAllowed

Implements iprm::IEnableableParam.

IsEnablingAllowed()

virtual bool iprm::CEnableableParam::IsEnablingAllowed ( ) const

overridevirtual

Return true if enabling/disabling is allowed.

Indicates whether the enable state can be changed. Some parameters may have fixed enable states based on system constraints or dependencies.

Returns

true if SetEnabled() can change the state, false if state is fixed.

if (param.IsEnablingAllowed())
{
    // User can toggle the enable state
    param.SetEnabled(!param.IsEnabled());
}
else
{
    // Enable state is fixed by system constraints
    qDebug() << "Cannot change enable state";
}

See also

SetEnabled

Implements iprm::IEnableableParam.

Serialize()

virtual bool iprm::CEnableableParam::Serialize ( iser::IArchive &  archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also

iser::IArchive

Implements iser::ISerializable.

Reimplemented in iqtgui::CHierarchicalCommand.

SetEnabled()

virtual bool iprm::CEnableableParam::SetEnabled ( bool  isEnabled = true )

overridevirtual

Set the enabled state.

Changes whether the parameter is enabled or disabled.

Parameters

isEnabled

New enable state. true to enable, false to disable.

Returns

true if the state change was allowed and successful, false otherwise.

Note

Returns false if IsEnablingAllowed() returns false.

Triggers CF_ENABLED notification on successful change.

// Enable
if (param.SetEnabled(true))
{
    qDebug() << "Successfully enabled";
}
 
// Disable
if (param.SetEnabled(false))
{
    qDebug() << "Successfully disabled";
}
 
// Toggle
param.SetEnabled(!param.IsEnabled());

See also

IsEnabled, IsEnablingAllowed, CF_ENABLED

Implements iprm::IEnableableParam.

Reimplemented in iqtgui::CHierarchicalCommand.

---

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

• Acf/Include/iprm/CEnableableParam.h