Namespaces
	AlarmCategoryKind

	AlarmStatusKind

Classes
class	IService

class	IClient

struct	AudioToneInfoType
	Description of the audio tone to be applied for an Alarm. More...

struct	AlarmConditionInfoType
	Contains information used to identify an Alarm Condition. More...

struct	AlarmConditionStatusType
	Contains information for the status of an Alarm Condition. More...

struct	ThreatConditionInfoType
	Contains information of Threat Alert types. More...

struct	AlarmCategoryInfoType
	Information of settings for Alarms of a specified category. More...

struct	AlertSettingsType
	Settings data for Alert Service. More...

struct	AlertStatusType
	Status data for Alerts. More...

struct	AlarmLogType
	Contains information for an Alarm log entry. More...

struct	AlarmAnnunciationType
	Contains information for an Alarm annunciation (text message) to be displayed below status bar. More...

struct	ThreatLogType
	Contains information for a Threat Alert log entry. More...

struct	ThreatAnnunciationType
	Contains information for a Threat Alert annunciation (text message) to be displayed in the HMI. More...

struct	CmdRaiseAlarm

struct	CmdResolveAlarm

struct	CmdAcknowledgeAlarm

struct	CmdOverrideAlarmCondition

struct	CmdUnoverrideAlarmCondition
	Causes the Alarm condition to be changed from being overridden to not overridden. More...

struct	CmdClearAlarm
	Clears one or more existing Alarms. More...

struct	CmdRaiseThreatAlert

struct	CmdCancelThreatAlert
	Used to Cancel one or more existing Threat Alerts which are no longer relevant. More...

struct	ReportAlertSettings
	Report static settings of the Alert Service. More...

struct	ReportAlertStatus
	Report the status with current count of active alarms and threats. More...

struct	ReportAlarmLog

struct	ReportAlarmAnnunciation

struct	ReportThreatLog
	Report an Alert for a detected Threat. More...

struct	ReportThreatAnnunciation

class	Service
	new oo-api More...

class	Client
	new oo-api More...

Typedefs
typedef std::string	AlertIdType

typedef std::vector< M_Alert::AlertIdType >	AlertIdListType
	List of AlertIdType. More...

typedef std::vector< M_Alert::AudioToneInfoType >	AudioToneInfoOptionalType

typedef std::vector< M_Alert::AlarmConditionStatusType >	AlarmConditionStatusListType
	List of AlarmConditionStatusType. More...

typedef std::vector< M_Alert::ThreatConditionInfoType >	ThreatConditionInfoListType
	List of ThreatConditionInfoType. More...

typedef std::shared_ptr< IClient >	IClientPtr

typedef std::shared_ptr< IService >	IServicePtr

Functions
std::vector< std::string >	getMethodsAllIService ()

std::vector< std::string >	getMethodsAllIClient ()

template<class IServiceDerived >
std::enable_if< std::is_same< IServiceDerived, std::vector< ddkit::callback::Base * > >::value, std::map< std::string, std::vector< ddkit::callback::Base * > > >::type	detectCallbacksIService (IServiceDerived &callbacks)

template<class IServiceDerived >
std::enable_if< std::is_same< IServiceDerived, std::vector< ddkit::callback::Base * > >::value, std::vector< std::string > >::type	detectMethodsIService (IServiceDerived &callbacks, bool isCheckMostDerivedClassType)

template<class IServiceDerived >
std::enable_if<!std::is_same< IServiceDerived, std::vector< ddkit::callback::Base * > >::value, std::vector< std::string > >::type	detectMethodsIService (IServiceDerived &callbacks, bool isCheckMostDerivedClassType)

template<class IClientDerived >
std::enable_if< std::is_same< IClientDerived, std::vector< ddkit::callback::Base * > >::value, std::map< std::string, std::vector< ddkit::callback::Base * > > >::type	detectCallbacksIClient (IClientDerived &callbacks)

template<class IClientDerived >
std::enable_if< std::is_same< IClientDerived, std::vector< ddkit::callback::Base * > >::value, std::vector< std::string > >::type	detectMethodsIClient (IClientDerived &callbacks, bool isCheckMostDerivedClassType)

template<class IClientDerived >
std::enable_if<!std::is_same< IClientDerived, std::vector< ddkit::callback::Base * > >::value, std::vector< std::string > >::type	detectMethodsIClient (IClientDerived &callbacks, bool isCheckMostDerivedClassType)

Typedef Documentation

◆ AlarmConditionStatusListType

typedef std::vector<M_Alert::AlarmConditionStatusType> M_Alert::AlarmConditionStatusListType

List of AlarmConditionStatusType.

◆ AlertIdListType

typedef std::vector<M_Alert::AlertIdType> M_Alert::AlertIdListType

List of AlertIdType.

◆ AlertIdType

typedef std::string M_Alert::AlertIdType

Id represented as a string. Note: This should normally contain a UUID string. For example: {A64E8BD7-FA0F-4073-82E0-ADDD47980B56}

◆ AudioToneInfoOptionalType

typedef std::vector<M_Alert::AudioToneInfoType> M_Alert::AudioToneInfoOptionalType

Optional AudioToneInfoType. List should only contain max 1 element. Empty list means no value is specified.

◆ IClientPtr

typedef std::shared_ptr<IClient> M_Alert::IClientPtr

◆ IServicePtr

typedef std::shared_ptr<IService> M_Alert::IServicePtr

◆ ThreatConditionInfoListType

typedef std::vector<M_Alert::ThreatConditionInfoType> M_Alert::ThreatConditionInfoListType

List of ThreatConditionInfoType.

Function Documentation

◆ detectCallbacksIClient()

template<class IClientDerived >

std::enable_if<std::is_same<IClientDerived, std::vector<ddkit::callback::Base*> >::value, std::map<std::string, std::vector<ddkit::callback::Base*> > >::type M_Alert::detectCallbacksIClient ( IClientDerived & callbacks )

◆ detectCallbacksIService()

template<class IServiceDerived >

std::enable_if<std::is_same<IServiceDerived, std::vector<ddkit::callback::Base*> >::value, std::map<std::string, std::vector<ddkit::callback::Base*> > >::type M_Alert::detectCallbacksIService ( IServiceDerived & callbacks )

◆ detectMethodsIClient() [1/2]

template<class IClientDerived >

std::enable_if<std::is_same<IClientDerived, std::vector<ddkit::callback::Base*> >::value, std::vector<std::string> >::type M_Alert::detectMethodsIClient	(	IClientDerived &	callbacks,
		bool	isCheckMostDerivedClassType
	)

◆ detectMethodsIClient() [2/2]

template<class IClientDerived >

std::enable_if<!std::is_same<IClientDerived, std::vector<ddkit::callback::Base*> >::value, std::vector<std::string> >::type M_Alert::detectMethodsIClient	(	IClientDerived &	callbacks,
		bool	isCheckMostDerivedClassType
	)

◆ detectMethodsIService() [1/2]

template<class IServiceDerived >

std::enable_if<std::is_same<IServiceDerived, std::vector<ddkit::callback::Base*> >::value, std::vector<std::string> >::type M_Alert::detectMethodsIService	(	IServiceDerived &	callbacks,
		bool	isCheckMostDerivedClassType
	)

◆ detectMethodsIService() [2/2]

template<class IServiceDerived >

std::enable_if<!std::is_same<IServiceDerived, std::vector<ddkit::callback::Base*> >::value, std::vector<std::string> >::type M_Alert::detectMethodsIService	(	IServiceDerived &	callbacks,
		bool	isCheckMostDerivedClassType
	)

◆ getMethodsAllIClient()

std::vector<std::string> M_Alert::getMethodsAllIClient ( )

◆ getMethodsAllIService()

std::vector<std::string> M_Alert::getMethodsAllIService ( )

Namespaces

Classes

Typedefs

Functions

Typedef Documentation

◆ AlarmConditionStatusListType

◆ AlertIdListType

◆ AlertIdType

◆ AudioToneInfoOptionalType

◆ IClientPtr

◆ IServicePtr

◆ ThreatConditionInfoListType

Function Documentation

◆ detectCallbacksIClient()

◆ detectCallbacksIService()

◆ detectMethodsIClient() [1/2]

◆ detectMethodsIClient() [2/2]

◆ detectMethodsIService() [1/2]

◆ detectMethodsIService() [2/2]

◆ getMethodsAllIClient()

◆ getMethodsAllIService()