Public Member Functions
	PublicationInfo (global_handle pid, const std::string &pkey, const std::string &ptype, const std::string &punits)

bool	CheckSetValue (const char *dataToCheck, uint64_t len)

bool	addSubscriber (global_handle newSubscriber)

void	removeSubscriber (global_handle subscriberToRemove)

Public Attributes
const global_handle	id
	the identifier for the containing federate

std::vector< global_handle >	subscribers
	container for all the subscribers of a publication

const std::string	key
	the key identifier for the publication

const std::string	type
	the type of the publication data

const std::string	units
	the units of the publication data

std::string	data
	the most recent publication data

bool	has_update {false}
	indicator that the publication has updates

bool	only_update_on_change {false}

bool	required {false}
	indicator that it is required to be output someplace

bool	buffer_data {false}
	indicator that the publication should buffer data

int32_t	required_connections {0}
	the number of required connections 0 is no requirement

Detailed Description

data class containing the information about a publication

Constructor & Destructor Documentation

helics::PublicationInfo::PublicationInfo	(	global_handle	pid,
		const std::string &	pkey,
		const std::string &	ptype,
		const std::string &	punits
	)

inline

constructor from the basic information

bool helics::PublicationInfo::addSubscriber ( global_handle newSubscriber )

add a new subscriber to the publication

References subscribers.

bool helics::PublicationInfo::CheckSetValue	(	const char *	dataToCheck,
		uint64_t	len
	)

check the value if it is the same as the most recent data and if changed, store it

References data.

void helics::PublicationInfo::removeSubscriber ( global_handle subscriberToRemove )

remove a subscriber

References subscribers.

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