helics::apps::Player Class Reference

#include <Player.hpp>

Inheritance diagram for helics::apps::Player:

Public Member Functions
	Player ()=default
	Player (std::vector< std::string > args)
	Player (int argc, char *argv[])
	Player (const std::string &name, const FederateInfo &fi)
	Player (const std::string &name, const std::shared_ptr< Core > &core, const FederateInfo &fi)
	Player (const std::string &name, CoreApp &core, const FederateInfo &fi)
	Player (const std::string &appName, const std::string &configString)
	Player (Player &&other_player)=default
Player &	operator= (Player &&fed)=default
virtual void	initialize () override
virtual void	runTo (Time stopTime_input) override
void	addPublication (const std::string &key, data_type type, const std::string &pubUnits=std::string())
template<class valType >
std::enable_if_t< helicsType< valType >) !=data_type::helics_custom >	addPublication (const std::string &key, const std::string &pubUnits=std::string())
void	addEndpoint (const std::string &endpointName, const std::string &endpointType=std::string())
template<class valType >
void	addPoint (Time pubTime, const std::string &key, const valType &val)
template<class valType >
void	addPoint (Time pubTime, int iteration, const std::string &key, const valType &val)
void	addMessage (Time sendTime, const std::string &src, const std::string &dest, const std::string &payload)
void	addMessage (Time sendTime, Time actionTime, const std::string &src, const std::string &dest, const std::string &payload)
auto	pointCount () const
auto	messageCount () const
auto	publicationCount () const
auto	endpointCount () const
const auto &	getPoint (int index) const
const auto &	getMessage (int index) const
Public Member Functions inherited from helics::apps::App
	App ()=default
	App (const std::string &defaultAppName, std::vector< std::string > args)
	App (const std::string &defaultAppName, int argc, char *argv[])
	App (const std::string &appName, const FederateInfo &fi)
	App (const std::string &appName, const std::shared_ptr< Core > &core, const FederateInfo &fi)
	App (const std::string &appName, CoreApp &core, const FederateInfo &fi)
	App (const std::string &appName, const std::string &jsonString)
	App (App &&other_app)=default
	App (const App &other_app)=delete
App &	operator= (App &&app)=default
App &	operator= (const App &app)=delete
void	loadFile (const std::string &filename)
virtual void	run ()
virtual void	finalize ()
bool	isActive () const
const CombinationFederate &	accessUnderlyingFederate () const

Additional Inherited Members
Protected Member Functions inherited from helics::apps::App
void	loadJsonFileConfiguration (const std::string &appName, const std::string &jsonString)
Protected Attributes inherited from helics::apps::App
std::shared_ptr< CombinationFederate >	fed
	the federate created for the Player
Time	stopTime = Time::maxVal()
	the time the Player should stop
std::string	masterFileName
	the name of the master file used to do the construction
bool	useLocal {false}
bool	fileLoaded {false}
bool	deactivated {false}
bool	quietMode {false}
bool	helpMode {false}
std::vector< std::string >	remArgs

Detailed Description

class implementing a Player object, which is capable of reading a file and generating interfaces and sending signals at the appropriate times

the Player class is not thread-safe, don't try to use it from multiple threads without external protection, that will result in undefined behavior

Constructor & Destructor Documentation

Player() [1/8]

helics::apps::Player::Player ( )

default

default constructor

Player() [2/8]

helics::apps::Player::Player ( std::vector< std::string >  args )

explicit

construct from command line arguments in a vector

Parameters

args	the command line arguments to pass in a reverse vector

Player() [3/8]

helics::apps::Player::Player	(	int	argc,
		char *	argv[]
	)

construct from command line arguments

Parameters

argc	the number of arguments
argv	the strings in the input

Player() [4/8]

helics::apps::Player::Player ( const std::string &  name, const FederateInfo &  fi  )

explicit

construct from a federate info object

Parameters

name	the name of the federate (can be empty to use defaults from fi)
fi	a pointer info object containing information on the desired federate configuration

References helics::apps::App::fed, and helics_flag_source_only.

Player() [5/8]

helics::apps::Player::Player	(	const std::string &	name,
		const std::shared_ptr< Core > &	core,
		const FederateInfo &	fi
	)

constructor taking a federate information structure and using the given core

Parameters

name	the name of the federate (can be empty to use defaults from fi)
core	a pointer to core object which the federate can join
fi	a federate information structure

References helics::apps::App::fed, and helics_flag_source_only.

Player() [6/8]

helics::apps::Player::Player	(	const std::string &	name,
		CoreApp &	core,
		const FederateInfo &	fi
	)

constructor taking a federate information structure and using the given core

Parameters

name	the name of the federate (can be empty to use defaults from fi)
core	a coreApp object that can be joined
fi	a federate information structure

References helics::apps::App::fed, and helics_flag_source_only.

Player() [7/8]

helics::apps::Player::Player	(	const std::string &	appName,
		const std::string &	configString
	)

constructor taking a file with the required information

Parameters

appName	the name of the app
configString	JSON, TOML or text file or JSON string defining the federate information and other configuration

References helics::apps::App::fed, and helics_flag_source_only.

Player() [8/8]

helics::apps::Player::Player ( Player &&  other_player )

default

move construction

Member Function Documentation

addEndpoint()

void helics::apps::Player::addEndpoint	(	const std::string &	endpointName,
		const std::string &	endpointType = std::string()
	)

add an endpoint to the Player

Parameters

endpointName	the name of the endpoint
endpointType	the named type of the endpoint

References helics::apps::App::fed.

addMessage() [1/2]

void helics::apps::Player::addMessage	(	Time	sendTime,
		const std::string &	src,
		const std::string &	dest,
		const std::string &	payload
	)

add a message to a Player queue

Parameters

sendTime	the time the message should be sent
src	the source endpoint of the message
dest	the destination endpoint of the message
payload	the payload of the message

addMessage() [2/2]

void helics::apps::Player::addMessage	(	Time	sendTime,
		Time	actionTime,
		const std::string &	src,
		const std::string &	dest,
		const std::string &	payload
	)

add an event for a specific time to a Player queue

Parameters

sendTime	the time the message should be sent
actionTime	the eventTime listed for the message
src	the source endpoint of the message
dest	the destination endpoint of the message
payload	the payload of the message

addPoint() [1/2]

template<class valType >

void helics::apps::Player::addPoint ( Time  pubTime, const std::string &  key, const valType &  val  )

inline

add a data point to publish through a Player

Parameters

pubTime	the time of the publication
key	the key for the publication
val	the value to publish

addPoint() [2/2]

template<class valType >

void helics::apps::Player::addPoint ( Time  pubTime, int  iteration, const std::string &  key, const valType &  val  )

inline

add a data point to publish through a Player

Parameters

pubTime	the time of the publication
iteration	the iteration count on which the value should be published
key	the key for the publication
val	the value to publish

addPublication() [1/2]

template<class valType >

std::enable_if_t<helicsType<valType>) != data_type::helics_custom> helics::apps::Player::addPublication ( const std::string &  key, const std::string &  pubUnits = std::string()  )

inline

add a publication to a Player

Parameters

key	the key of the publication to add
pubUnits	the units associated with the publication

References fed.

addPublication() [2/2]

void helics::apps::Player::addPublication	(	const std::string &	key,
		data_type	type,
		const std::string &	pubUnits = std::string()
	)

add a publication to a Player

Parameters

key	the key of the publication to add
type	the type of the publication
pubUnits	the units associated with the publication

References helics::apps::App::fed.

endpointCount()

auto helics::apps::Player::endpointCount ( ) const

inline

get the number of endpoints

getMessage()

const auto& helics::apps::Player::getMessage ( int  index ) const

inline

get the messages from an index

getPoint()

const auto& helics::apps::Player::getPoint ( int  index ) const

inline

get the point from an index

initialize()

void helics::apps::Player::initialize ( )

overridevirtual

initialize the Player federate

generate all the publications and organize the points, the final publication count will be available after this time and the Player will enter the initialization mode, which means it will not be possible to add more publications calling run will automatically do this if necessary

Reimplemented from helics::apps::App.

References helics::apps::App::fed, and helics::Federate::startup.

Referenced by runTo().

messageCount()

auto helics::apps::Player::messageCount ( ) const

inline

get the number of messages loaded

operator=()

Player& helics::apps::Player::operator= ( Player &&  fed )

default

move assignment

pointCount()

auto helics::apps::Player::pointCount ( ) const

inline

get the number of points loaded

publicationCount()

auto helics::apps::Player::publicationCount ( ) const

inline

get the number of publications

runTo()

void helics::apps::Player::runTo ( Time  stopTime_input )

overridevirtual

run the Player until the specified time

Parameters

stopTime_input

the desired stop time

Implements helics::apps::App.

References helics::Federate::executing, helics::apps::App::fed, helics::force_iteration, initialize(), helics::isValidIndex(), helics::Federate::startup, and helics::timeZero.

---

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

• Player.hpp
• Player.cpp