Implementation of standard trigger parameters set. More...

#include <CTriggerParamsComp.h>

Inheritance diagram for isig::CTriggerParamsComp:

Collaboration diagram for isig::CTriggerParamsComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from isig::ITriggerParams
enum	TriggerMode { TM_NONE , TM_CONTINUOUS , TM_RISING_EDGE , TM_FALLING_EDGE , TM_POSITIVE_LEVEL , TM_NEGATIVE_LEVEL , TM_SOFTWARE , TM_LAST = TM_SOFTWARE }
	Describe working mode of trigger signal. More...

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 iprm::ISelectionParam
enum	ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
	Data model change notification flags. More...

enum	{ NO_SELECTION = -1 }

Public Member Functions
	CTriggerParamsComp ()

const ITriggerConstraints *	GetTriggerConstraints () const override
	Get constraints describing supported parameter states.

int	GetTriggerMode () const override
	Get trigger mode.

void	SetTriggerMode (int triggerMode) override
	Set trigger mode.

int	GetTriggersCount () const override
	Get the number of triggers in the `TM_CONTINUOUS` mode.

void	SetTriggersCount (int triggersCount) override
	Set the number of triggers in the `TM_CONTINUOUS` mode.

const iprm::IOptionsList *	GetSelectionConstraints () const override
	Get constraints of this parameter.

QByteArray	GetSelectedOptionId () const override
	Get selected ID.

int	GetSelectedOptionIndex () const override
	Get selected index.

bool	SetSelectedOptionIndex (int index) override
	Set index of selected option.

iprm::ISelectionParam *	GetSubselection (int index) const override
	Get subselection for specified option.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

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 isig::ITriggerParams
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 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 iprm::ISelectionParam

Protected Member Functions
void	InitializeSelectionList ()

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

Implementation of standard trigger parameters set.

Definition at line 27 of file CTriggerParamsComp.h.

Member Typedef Documentation

◆ BaseClass

icomp::CComponentBase isig::CTriggerParamsComp::BaseClass

Definition at line 34 of file CTriggerParamsComp.h.

Constructor & Destructor Documentation

◆ CTriggerParamsComp()

isig::CTriggerParamsComp::CTriggerParamsComp ( )

Member Function Documentation

◆ GetOptionDescription()

QString isig::CTriggerParamsComp::GetOptionDescription ( int index ) const

overrideprotectedvirtual

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

Implements iprm::IOptionsList.

◆ GetOptionId()

QByteArray isig::CTriggerParamsComp::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 isig::CTriggerParamsComp::GetOptionName ( int index ) const

overrideprotectedvirtual

Get name of specified option.

Implements iprm::IOptionsList.

◆ GetOptionsCount()

int isig::CTriggerParamsComp::GetOptionsCount ( ) const

overrideprotectedvirtual

Get number of managed options.

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

int isig::CTriggerParamsComp::GetOptionsFlags ( ) const

overrideprotectedvirtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

◆ GetSelectedOptionId()

QByteArray isig::CTriggerParamsComp::GetSelectedOptionId ( ) const

overridevirtual

Get selected ID.

Returns: ID of selected option.

Implements iprm::ISelectionParam.

◆ GetSelectedOptionIndex()

int isig::CTriggerParamsComp::GetSelectedOptionIndex ( ) const

overridevirtual

Get selected index.

Returns: index of selected option or negative value if no option is selected.

Implements iprm::ISelectionParam.

◆ GetSelectionConstraints()

const iprm::IOptionsList * isig::CTriggerParamsComp::GetSelectionConstraints ( ) const

overridevirtual

Get constraints of this parameter.

Constraints describes some additional information about allowed parameter ranges and related informations.

Implements iprm::ISelectionParam.

◆ GetSubselection()

iprm::ISelectionParam * isig::CTriggerParamsComp::GetSubselection ( int index ) const

overridevirtual

Get subselection for specified option.

Please note, that returned options tree belongs to selection data model.

Implements iprm::ISelectionParam.

◆ GetTriggerConstraints()

const ITriggerConstraints * isig::CTriggerParamsComp::GetTriggerConstraints ( ) const

overridevirtual

Get constraints describing supported parameter states.

Implements isig::ITriggerParams.

◆ GetTriggerMode()

int isig::CTriggerParamsComp::GetTriggerMode ( ) const

overridevirtual

Get trigger mode.

Normal trigger modes are defined in isig::ITriggerParams::TriggerMode.

Implements isig::ITriggerParams.

◆ GetTriggersCount()

int isig::CTriggerParamsComp::GetTriggersCount ( ) const

overridevirtual

Get the number of triggers in the TM_CONTINUOUS mode.

A negative value means that the signal acquisition runs infinitely

See also: TriggerMode

Implements isig::ITriggerParams.

◆ InitializeSelectionList()

void isig::CTriggerParamsComp::InitializeSelectionList ( )

protected

◆ IsOptionEnabled()

bool isig::CTriggerParamsComp::IsOptionEnabled ( int index ) const

overrideprotectedvirtual

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

Implements iprm::IOptionsList.

◆ OnComponentCreated()

void isig::CTriggerParamsComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

bool isig::CTriggerParamsComp::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.

◆ SetSelectedOptionIndex()

bool isig::CTriggerParamsComp::SetSelectedOptionIndex ( int index )

overridevirtual

Set index of selected option.

Returns: true if selection change was possible.

Implements iprm::ISelectionParam.

◆ SetTriggerMode()

void isig::CTriggerParamsComp::SetTriggerMode ( int triggerMode )

overridevirtual

Set trigger mode.

Normal trigger modes are defined in isig::ITriggerParams::TriggerMode.

Implements isig::ITriggerParams.

◆ SetTriggersCount()

void isig::CTriggerParamsComp::SetTriggersCount ( int triggersCount )

overridevirtual

Set the number of triggers in the TM_CONTINUOUS mode.

See also: TriggerMode

Implements isig::ITriggerParams.

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

isig/CTriggerParamsComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CTriggerParamsComp()

Member Function Documentation

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ GetSelectedOptionId()

◆ GetSelectedOptionIndex()

◆ GetSelectionConstraints()

◆ GetSubselection()

◆ GetTriggerConstraints()

◆ GetTriggerMode()

◆ GetTriggersCount()

◆ InitializeSelectionList()

◆ IsOptionEnabled()

◆ OnComponentCreated()

◆ Serialize()

◆ SetSelectedOptionIndex()

◆ SetTriggerMode()

◆ SetTriggersCount()