Describes how the Presence is configured for a group of type Group::gtPresence in Group::Type_t. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	Format_t { pfUnknown = 0 , pfEngage = 1 , pfCot = 2 }
	Presence format types enum. More...

Public Member Functions
void	clear ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()

virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
Format_t	format
	Format to be used to represent presence information.

int	intervalSecs
	[Optional, Default: 30] The interval in seconds at which to send the presence descriptor on the presence group

bool	listenOnly
	Instructs the Engage Engine to not transmit presence descriptor.

int	minIntervalSecs
	[Optional, Default: 5] The minimum interval to send at to prevent network flooding

bool	reduceImmediacy
	[Optional, Default: false] Instructs the Engage Engine reduce the immediacy of presence announcements wherever possible

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Describes how the Presence is configured for a group of type Group::gtPresence in Group::Type_t.

Helper C++ class to serialize and de-serialize Presence JSON

Example:

{
   "forceOnAudioTransmit": false,
   "format": 0,
   "intervalSecs": 30,
   "listenOnly": false
}

See also: Group

Definition at line 4234 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ Format_t

enum AppConfigurationObjects::Presence::Format_t

Presence format types enum.

Enumerator

pfUnknown

Unknown.

pfEngage

Engage propriety format.

pfCot

Cursor On Target format.

This is a simple XML based exchange standard that is used to share information about targets. Cursor on Target was originally developed by MITRE in 2002 in support of the U.S. Air Force Electronic Systems Center (ESC)

Definition at line 4243 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Presence()

AppConfigurationObjects::Presence::Presence ( )

inline

Definition at line 4275 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Presence::clear ( )

inline

Definition at line 4280 of file ConfigurationObjects.h.

Member Data Documentation

◆ format

Format_t AppConfigurationObjects::Presence::format

Format to be used to represent presence information.

Definition at line 4261 of file ConfigurationObjects.h.

◆ intervalSecs

int AppConfigurationObjects::Presence::intervalSecs

[Optional, Default: 30] The interval in seconds at which to send the presence descriptor on the presence group

Definition at line 4264 of file ConfigurationObjects.h.

◆ listenOnly

bool AppConfigurationObjects::Presence::listenOnly

Instructs the Engage Engine to not transmit presence descriptor.

Definition at line 4267 of file ConfigurationObjects.h.

◆ minIntervalSecs

int AppConfigurationObjects::Presence::minIntervalSecs

[Optional, Default: 5] The minimum interval to send at to prevent network flooding

Definition at line 4270 of file ConfigurationObjects.h.

◆ reduceImmediacy

bool AppConfigurationObjects::Presence::reduceImmediacy

[Optional, Default: false] Instructs the Engage Engine reduce the immediacy of presence announcements wherever possible

Definition at line 4273 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members