Basda::Microgate::WriteCommandStarter Class Reference

This starter executes a BCU write command. More...

#include <WriteCommandStarter.h>

Inheritance diagram for Basda::Microgate::WriteCommandStarter:

Collaboration diagram for Basda::Microgate::WriteCommandStarter:

Public Types
typedef Basda::Microgate::BcuWriteCommand	BcuWriteCommand
typedef Basda::Microgate::BcuWriteCommandPtr	BcuWriteCommandPtr
typedef Basda::Microgate::BcuReply	BcuReply
typedef Basda::Microgate::BcuReplyPtr	BcuReplyPtr
typedef Basda::Microgate::OpCode	OpCode
typedef Basda::Microgate::PayloadSizeRange	PayloadSizeRange
typedef Basda::Microgate::BcuWriteCommand	BcuWriteCommand
typedef Basda::Microgate::BcuWriteCommandPtr	BcuWriteCommandPtr
typedef Basda::Microgate::BcuReply	BcuReply
typedef Basda::Microgate::BcuReplyPtr	BcuReplyPtr
typedef Basda::Microgate::OpCode	OpCode
typedef Basda::Microgate::PayloadSizeRange	PayloadSizeRange

Public Member Functions
	WriteCommandStarter (const PayloadSizeRange &range)
int	execute (int argc, char **argv, CreateBcuWriteRequestFunctionPtr createCommand)
virtual	~WriteCommandStarter ()
	WriteCommandStarter (const PayloadSizeRange &range)
int	execute (int argc, char **argv, CreateBcuWriteRequestFunctionPtr createCommand)
virtual	~WriteCommandStarter ()
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 (boost::program_options::variables_map &vm, const boost::program_options::options_description &desc)
int	executeWriteCommand (CreateBcuWriteRequestFunctionPtr createCommand)
BcuWriteRequestPtr	buildRequest (CreateBcuWriteRequestFunctionPtr createCommand)
void	checkPayloadRange ()
void	printArgumentsIfDesired ()
void	printUsageAndExit (const boost::program_options::options_description &desc)
void	parseArguments (int argc, char **argv)
void	checkArguments (boost::program_options::variables_map &vm, const boost::program_options::options_description &desc)
int	executeWriteCommand (CreateBcuWriteRequestFunctionPtr createCommand)
BcuWriteRequestPtr	buildRequest (CreateBcuWriteRequestFunctionPtr createCommand)
void	checkPayloadRange ()
void	printArgumentsIfDesired ()

Private Attributes
std::string	ipv4Address_
uint16_t	remoteUdpPort_
uint16_t	localUdpPort_
int32_t	memoryAddress_
uint8_t	firstDsp_
uint8_t	lastDsp_
uint8_t	messageId_
std::vector< int32_t >	payload_
std::string	programName_
std::string	long_argument_payload_
std::string	short_argument_payload_
std::string	option_payload_
std::string	long_argument_firstDsp_
std::string	short_argument_firstDsp_
std::string	option_firstDsp_
std::string	long_argument_lastDsp_
std::string	short_argument_lastDsp_
std::string	option_lastDsp_
PayloadSizeRange	payloadSizeRange_

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 starter executes a BCU write command.

Member Typedef Documentation

BcuReply [1/2]

typedef Basda::Microgate::BcuReply Basda::Microgate::WriteCommandStarter::BcuReply

BcuReply [2/2]

typedef Basda::Microgate::BcuReply Basda::Microgate::WriteCommandStarter::BcuReply

BcuReplyPtr [1/2]

typedef Basda::Microgate::BcuReplyPtr Basda::Microgate::WriteCommandStarter::BcuReplyPtr

BcuReplyPtr [2/2]

typedef Basda::Microgate::BcuReplyPtr Basda::Microgate::WriteCommandStarter::BcuReplyPtr

BcuWriteCommand [1/2]

typedef Basda::Microgate::BcuWriteCommand Basda::Microgate::WriteCommandStarter::BcuWriteCommand

BcuWriteCommand [2/2]

typedef Basda::Microgate::BcuWriteCommand Basda::Microgate::WriteCommandStarter::BcuWriteCommand

BcuWriteCommandPtr [1/2]

typedef Basda::Microgate::BcuWriteCommandPtr Basda::Microgate::WriteCommandStarter::BcuWriteCommandPtr

BcuWriteCommandPtr [2/2]

typedef Basda::Microgate::BcuWriteCommandPtr Basda::Microgate::WriteCommandStarter::BcuWriteCommandPtr

OpCode [1/2]

typedef Basda::Microgate::OpCode Basda::Microgate::WriteCommandStarter::OpCode

OpCode [2/2]

typedef Basda::Microgate::OpCode Basda::Microgate::WriteCommandStarter::OpCode

PayloadSizeRange [1/2]

typedef Basda::Microgate::PayloadSizeRange Basda::Microgate::WriteCommandStarter::PayloadSizeRange

PayloadSizeRange [2/2]

typedef Basda::Microgate::PayloadSizeRange Basda::Microgate::WriteCommandStarter::PayloadSizeRange

Constructor & Destructor Documentation

WriteCommandStarter() [1/2]

Basda::Microgate::WriteCommandStarter::WriteCommandStarter ( const PayloadSizeRange &  range )

inlineexplicit

~WriteCommandStarter() [1/2]

virtual Basda::Microgate::WriteCommandStarter::~WriteCommandStarter ( )

inlinevirtual

Note

overridden

WriteCommandStarter() [2/2]

Basda::Microgate::WriteCommandStarter::WriteCommandStarter ( const PayloadSizeRange &  range )

inlineexplicit

~WriteCommandStarter() [2/2]

virtual Basda::Microgate::WriteCommandStarter::~WriteCommandStarter ( )

inlinevirtual

Note

overridden

Member Function Documentation

buildRequest() [1/2]

BcuWriteRequestPtr Basda::Microgate::WriteCommandStarter::buildRequest ( CreateBcuWriteRequestFunctionPtr  createCommand )

inlineprivate

buildRequest() [2/2]

BcuWriteRequestPtr Basda::Microgate::WriteCommandStarter::buildRequest ( CreateBcuWriteRequestFunctionPtr  createCommand )

inlineprivate

checkArguments() [1/2]

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

inlineprivate

checkArguments() [2/2]

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

inlineprivate

checkPayloadRange() [1/2]

void Basda::Microgate::WriteCommandStarter::checkPayloadRange ( )

inlineprivate

checkPayloadRange() [2/2]

void Basda::Microgate::WriteCommandStarter::checkPayloadRange ( )

inlineprivate

execute() [1/2]

int Basda::Microgate::WriteCommandStarter::execute ( int  argc, char **  argv, CreateBcuWriteRequestFunctionPtr  createCommand  )

inline

execute() [2/2]

int Basda::Microgate::WriteCommandStarter::execute ( int  argc, char **  argv, CreateBcuWriteRequestFunctionPtr  createCommand  )

inline

executeWriteCommand() [1/2]

int Basda::Microgate::WriteCommandStarter::executeWriteCommand ( CreateBcuWriteRequestFunctionPtr  createCommand )

inlineprivate

executeWriteCommand() [2/2]

int Basda::Microgate::WriteCommandStarter::executeWriteCommand ( CreateBcuWriteRequestFunctionPtr  createCommand )

inlineprivate

parseArguments() [1/2]

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

inlineprivate

parseArguments() [2/2]

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

inlineprivate

printArgumentsIfDesired() [1/2]

void Basda::Microgate::WriteCommandStarter::printArgumentsIfDesired ( )

inlineprivate

printArgumentsIfDesired() [2/2]

void Basda::Microgate::WriteCommandStarter::printArgumentsIfDesired ( )

inlineprivate

printUsageAndExit() [1/2]

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

inlineprivate

printUsageAndExit() [2/2]

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

inlineprivate

Member Data Documentation

firstDsp_

uint8_t Basda::Microgate::WriteCommandStarter::firstDsp_

private

ipv4Address_

std::string Basda::Microgate::WriteCommandStarter::ipv4Address_

private

lastDsp_

uint8_t Basda::Microgate::WriteCommandStarter::lastDsp_

private

localUdpPort_

uint16_t Basda::Microgate::WriteCommandStarter::localUdpPort_

private

long_argument_firstDsp_

std::string Basda::Microgate::WriteCommandStarter::long_argument_firstDsp_

private

long_argument_lastDsp_

std::string Basda::Microgate::WriteCommandStarter::long_argument_lastDsp_

private

long_argument_payload_

std::string Basda::Microgate::WriteCommandStarter::long_argument_payload_

private

memoryAddress_

int32_t Basda::Microgate::WriteCommandStarter::memoryAddress_

private

messageId_

uint8_t Basda::Microgate::WriteCommandStarter::messageId_

private

option_firstDsp_

std::string Basda::Microgate::WriteCommandStarter::option_firstDsp_

private

option_lastDsp_

std::string Basda::Microgate::WriteCommandStarter::option_lastDsp_

private

option_payload_

std::string Basda::Microgate::WriteCommandStarter::option_payload_

private

payload_

std::vector< int32_t > Basda::Microgate::WriteCommandStarter::payload_

private

payloadSizeRange_

PayloadSizeRange Basda::Microgate::WriteCommandStarter::payloadSizeRange_

private

programName_

std::string Basda::Microgate::WriteCommandStarter::programName_

private

remoteUdpPort_

uint16_t Basda::Microgate::WriteCommandStarter::remoteUdpPort_

private

short_argument_firstDsp_

std::string Basda::Microgate::WriteCommandStarter::short_argument_firstDsp_

private

short_argument_lastDsp_

std::string Basda::Microgate::WriteCommandStarter::short_argument_lastDsp_

private

short_argument_payload_

std::string Basda::Microgate::WriteCommandStarter::short_argument_payload_

private

---

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

• TwiceAsNice/basda-misda/doc/include/WriteCommandStarter.h