This command line parser executes a BCU read command. More...

#include <SingleDwordReadCommandStarter.h>

Inheritance diagram for Basda::Microgate::SingleDwordReadCommandStarter:

Collaboration diagram for Basda::Microgate::SingleDwordReadCommandStarter:

Public Types
typedef Basda::Microgate::UdpConnectionPtr	UdpConnectionPtr

typedef Basda::Microgate::BcuReadCommand	BcuReadCommand

typedef Basda::Microgate::BcuReadCommandPtr	BcuReadCommandPtr

typedef Basda::Microgate::UdpConnectionPtr	UdpConnectionPtr

typedef Basda::Microgate::BcuReadCommand	BcuReadCommand

typedef Basda::Microgate::BcuReadCommandPtr	BcuReadCommandPtr

Public Member Functions
	SingleDwordReadCommandStarter ()

int	execute (int argc, char **argv, CreateBcuReadRequestFunctionPtr createReadRequest)

virtual	~SingleDwordReadCommandStarter ()

	SingleDwordReadCommandStarter ()

int	execute (int argc, char **argv, CreateBcuReadRequestFunctionPtr createReadRequest)

virtual	~SingleDwordReadCommandStarter ()

Public Member Functions inherited from Basda::Microgate::BasicCommandStarter
	BasicCommandStarter ()

virtual	~BasicCommandStarter ()=0

	BasicCommandStarter ()

virtual	~BasicCommandStarter ()=0

Private Member Functions
void	printUsageAndExit (const boost::program_options::options_description &desc)

void	parseArguments (int argc, char **argv)

void	checkArguments (const boost::program_options::variables_map &vm, const boost::program_options::options_description &desc)

int	executeReadCommand (CreateBcuReadRequestFunctionPtr createReadRequest)

void	printUsageAndExit (const boost::program_options::options_description &desc)

void	parseArguments (int argc, char **argv)

void	checkArguments (const boost::program_options::variables_map &vm, const boost::program_options::options_description &desc)

int	executeReadCommand (CreateBcuReadRequestFunctionPtr createReadRequest)

Private Attributes
std::string	programName_

std::string	ipv4Address_

uint16_t	remoteUdpPort_

uint16_t	localUdpPort_

int32_t	memoryAddress_

uint8_t	messageId_

uint8_t	dsp_

std::string	long_argument_dsp_

std::string	short_argument_dsp_

std::string	option_dsp_

Additional Inherited Members
Static Public Member Functions inherited from Basda::Microgate::BasicCommandStarter
static void	printError (const std::string &message)

static void	printError (const std::string &message)

Protected Member Functions inherited from Basda::Microgate::BasicCommandStarter
std::string	toOption (const std::string &longArg, const std::string &shortArg)

boost::program_options::options_description	createAllowedBasicOptions ()

bool	areBasicArgumentsGiven (const boost::program_options::variables_map &vm)

void	printUsage (const std::string &programName, const boost::program_options::options_description &desc, const std::string &missingOptionExample)

std::string	toOption (const std::string &longArg, const std::string &shortArg)

boost::program_options::options_description	createAllowedBasicOptions ()

bool	areBasicArgumentsGiven (const boost::program_options::variables_map &vm)

void	printUsage (const std::string &programName, const boost::program_options::options_description &desc, const std::string &missingOptionExample)

Protected Attributes inherited from Basda::Microgate::BasicCommandStarter
std::string	long_argument_bcu_

std::string	short_argument_bcu_

std::string	option_bcu_

std::string	long_argument_port_

std::string	short_argument_port_

std::string	option_port_

std::string	long_argument_local_port_

std::string	short_argument_local_port_

std::string	option_local_port_

std::string	long_argument_message_

std::string	short_argument_message_

std::string	option_message_

std::string	long_argument_memory_

std::string	short_argument_memory_

std::string	option_memory_

Detailed Description

This command line parser executes a BCU read command.

Member Typedef Documentation

◆ BcuReadCommand [1/2]

typedef Basda::Microgate::BcuReadCommand Basda::Microgate::SingleDwordReadCommandStarter::BcuReadCommand

◆ BcuReadCommand [2/2]

typedef Basda::Microgate::BcuReadCommand Basda::Microgate::SingleDwordReadCommandStarter::BcuReadCommand

◆ BcuReadCommandPtr [1/2]

typedef Basda::Microgate::BcuReadCommandPtr Basda::Microgate::SingleDwordReadCommandStarter::BcuReadCommandPtr

◆ BcuReadCommandPtr [2/2]

typedef Basda::Microgate::BcuReadCommandPtr Basda::Microgate::SingleDwordReadCommandStarter::BcuReadCommandPtr

◆ UdpConnectionPtr [1/2]

typedef Basda::Microgate::UdpConnectionPtr Basda::Microgate::SingleDwordReadCommandStarter::UdpConnectionPtr

◆ UdpConnectionPtr [2/2]

typedef Basda::Microgate::UdpConnectionPtr Basda::Microgate::SingleDwordReadCommandStarter::UdpConnectionPtr

Constructor & Destructor Documentation

◆ SingleDwordReadCommandStarter() [1/2]

Basda::Microgate::SingleDwordReadCommandStarter::SingleDwordReadCommandStarter ( )

inline

◆ ~SingleDwordReadCommandStarter() [1/2]

virtual Basda::Microgate::SingleDwordReadCommandStarter::~SingleDwordReadCommandStarter ( )

inlinevirtual

Note: overridden

◆ SingleDwordReadCommandStarter() [2/2]

Basda::Microgate::SingleDwordReadCommandStarter::SingleDwordReadCommandStarter ( )

inline

◆ ~SingleDwordReadCommandStarter() [2/2]

virtual Basda::Microgate::SingleDwordReadCommandStarter::~SingleDwordReadCommandStarter ( )

inlinevirtual

Note: overridden

Member Function Documentation

◆ checkArguments() [1/2]

void Basda::Microgate::SingleDwordReadCommandStarter::checkArguments	(	const boost::program_options::variables_map &	vm,
		const boost::program_options::options_description &	desc
	)

inlineprivate

◆ checkArguments() [2/2]

void Basda::Microgate::SingleDwordReadCommandStarter::checkArguments	(	const boost::program_options::variables_map &	vm,
		const boost::program_options::options_description &	desc
	)

inlineprivate

◆ execute() [1/2]

int Basda::Microgate::SingleDwordReadCommandStarter::execute	(	int	argc,
		char **	argv,
		CreateBcuReadRequestFunctionPtr	createReadRequest
	)

inline

◆ execute() [2/2]

int Basda::Microgate::SingleDwordReadCommandStarter::execute	(	int	argc,
		char **	argv,
		CreateBcuReadRequestFunctionPtr	createReadRequest
	)

inline

◆ executeReadCommand() [1/2]

int Basda::Microgate::SingleDwordReadCommandStarter::executeReadCommand ( CreateBcuReadRequestFunctionPtr createReadRequest )

inlineprivate

◆ executeReadCommand() [2/2]

int Basda::Microgate::SingleDwordReadCommandStarter::executeReadCommand ( CreateBcuReadRequestFunctionPtr createReadRequest )

inlineprivate

◆ parseArguments() [1/2]

void Basda::Microgate::SingleDwordReadCommandStarter::parseArguments	(	int	argc,
		char **	argv
	)

inlineprivate

◆ parseArguments() [2/2]

void Basda::Microgate::SingleDwordReadCommandStarter::parseArguments	(	int	argc,
		char **	argv
	)

inlineprivate

◆ printUsageAndExit() [1/2]

void Basda::Microgate::SingleDwordReadCommandStarter::printUsageAndExit ( const boost::program_options::options_description & desc )

inlineprivate

◆ printUsageAndExit() [2/2]

void Basda::Microgate::SingleDwordReadCommandStarter::printUsageAndExit ( const boost::program_options::options_description & desc )

inlineprivate

Member Data Documentation

◆ dsp_

uint8_t Basda::Microgate::SingleDwordReadCommandStarter::dsp_

private

◆ ipv4Address_

std::string Basda::Microgate::SingleDwordReadCommandStarter::ipv4Address_

private

◆ localUdpPort_

uint16_t Basda::Microgate::SingleDwordReadCommandStarter::localUdpPort_

private

◆ long_argument_dsp_

std::string Basda::Microgate::SingleDwordReadCommandStarter::long_argument_dsp_

private

◆ memoryAddress_

int32_t Basda::Microgate::SingleDwordReadCommandStarter::memoryAddress_

private

◆ messageId_

uint8_t Basda::Microgate::SingleDwordReadCommandStarter::messageId_

private

◆ option_dsp_

std::string Basda::Microgate::SingleDwordReadCommandStarter::option_dsp_

private

◆ programName_

std::string Basda::Microgate::SingleDwordReadCommandStarter::programName_

private

◆ remoteUdpPort_

uint16_t Basda::Microgate::SingleDwordReadCommandStarter::remoteUdpPort_

private

◆ short_argument_dsp_

std::string Basda::Microgate::SingleDwordReadCommandStarter::short_argument_dsp_

private

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

TwiceAsNice/basda-misda/doc/include/SingleDwordReadCommandStarter.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BcuReadCommand [1/2]

◆ BcuReadCommand [2/2]

◆ BcuReadCommandPtr [1/2]

◆ BcuReadCommandPtr [2/2]

◆ UdpConnectionPtr [1/2]

◆ UdpConnectionPtr [2/2]

Constructor & Destructor Documentation

◆ SingleDwordReadCommandStarter() [1/2]

◆ ~SingleDwordReadCommandStarter() [1/2]

◆ SingleDwordReadCommandStarter() [2/2]

◆ ~SingleDwordReadCommandStarter() [2/2]

Member Function Documentation

◆ checkArguments() [1/2]

◆ checkArguments() [2/2]

◆ execute() [1/2]

◆ execute() [2/2]

◆ executeReadCommand() [1/2]

◆ executeReadCommand() [2/2]

◆ parseArguments() [1/2]

◆ parseArguments() [2/2]

◆ printUsageAndExit() [1/2]

◆ printUsageAndExit() [2/2]

Member Data Documentation

◆ dsp_

◆ ipv4Address_

◆ localUdpPort_

◆ long_argument_dsp_

◆ memoryAddress_

◆ messageId_

◆ option_dsp_

◆ programName_

◆ remoteUdpPort_

◆ short_argument_dsp_