Modularity::SPI::Config Class Reference

This class contains all the methods to Config a Service or a device when attached to a Service. More...

#include <Config.h>

Public Member Functions
SPILIBRARY_API	Config ()
	This constructor is used when service is running on the machine as dynamic library.
SPILIBRARY_API	Config (string IP, PortType RFU)
	This constructor is used when service is running on remoted TCP service.
SPILIBRARY_API	Config (string COMPort)
	This constructor is used when service is running on remote serial service.
SPILIBRARY_API	Config (const Config &TmpConfig)
	Copy constructor.
SPILIBRARY_API Config &	operator= (const Config &NewConfig)
	Copy constructor.
SPILIBRARY_API SPI_RET_VAL	SetCertificateFilesDirectory (string Path)
	Set certificate directory.
SPILIBRARY_API SPI_RET_VAL	SetProcessorIPAddress (string IPAddress)
	Set Proccessor IP address directory. For SHVA test envitment set the following address: 193.142.151.62.
SPILIBRARY_API SPI_RET_VAL	SetProcessorPortNumber (PortType Port)
	Set Proccessor Port number. For SHVA test envitment calling this method is not necessary.
SPILIBRARY_API SPI_RET_VAL	SetManufactureID (string ID)
	Manufacture Id in Process.
SPILIBRARY_API SPI_RET_VAL	SetECRIdentifier (string ID)
	ECR Identifier number In AshraitEMV , ID must be a number in range of 1:999.
SPILIBRARY_API void	EnableMiniSettelment ()
	Enable mini settelment transmission post sucessful transaction. Mini-settlment is done as part of thr transaction and transmitted to the IP set in SetProcessorIP()
SPILIBRARY_API void	SetProcessorID (Modularity::SPI::Ashrait::ProcessorId Id)
	Set your service processor. Using this will load deafult certificate and settings for choosen processor. AshraitEMV service Note: SetProcessorIPAddress() and SetProcessorPortNumber() are still mandatory. Default value is ABS.
SPILIBRARY_API string	GetIP ()
	Get IP provided in TCP based in TCP constructor.
SPILIBRARY_API string	GetCOM ()
	Get Serial port provided in Seri based in TCP constructor.
SPILIBRARY_API ExcUnitLocation	GetEUL ()
	Get the execute location of the service.
SPILIBRARY_API SPI_STATUS	GetStatus ()
	Get status of Config (Not supported in this version)
SPILIBRARY_API	~Config ()
	default destructor
APIHandle	GetConfigHandle ()
	Reserved for internal useage.

Detailed Description

This class contains all the methods to Config a Service or a device when attached to a Service.

Examples:

CPP_Examples.cpp.

Definition at line 33 of file Config.h.

Constructor & Destructor Documentation

SPILIBRARY_API Modularity::SPI::Config::Config	(	string	IP,
		PortType	RFU
	)

This constructor is used when service is running on remoted TCP service.

Parameters

[in]	IP	is the Service IP address
[in]	RFU	is unsued for this version

SPILIBRARY_API Modularity::SPI::Config::Config

(

string

COMPort

)

This constructor is used when service is running on remote serial service.

Parameters

[in]

COMPort

is a string describing the Service serial port location. (COM/USB)

SPILIBRARY_API Modularity::SPI::Config::Config

(

const Config &

TmpConfig

)

Copy constructor.

Parameters

[in]

TmpConfig

object

Member Function Documentation

SPILIBRARY_API void Modularity::SPI::Config::EnableMiniSettelment

(

)

Enable mini settelment transmission post sucessful transaction. Mini-settlment is done as part of thr transaction and transmitted to the IP set in SetProcessorIP()

Returns

void

SPILIBRARY_API string Modularity::SPI::Config::GetCOM

(

)

Get Serial port provided in Seri based in TCP constructor.

Returns

a string with result

SPILIBRARY_API ExcUnitLocation Modularity::SPI::Config::GetEUL

(

)

Get the execute location of the service.

Returns

Matching enum result

SPILIBRARY_API string Modularity::SPI::Config::GetIP

(

)

Get IP provided in TCP based in TCP constructor.

Returns

a string with result

SPILIBRARY_API SPI_STATUS Modularity::SPI::Config::GetStatus

(

)

Get status of Config (Not supported in this version)

Returns

Matching enum result

SPILIBRARY_API Config& Modularity::SPI::Config::operator=

(

const Config &

NewConfig

)

Copy constructor.

Parameters

[in]

NewConfig

object as left operand

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetCertificateFilesDirectory

(

string

Path

)

Set certificate directory.

Parameters

[in]

Path

is path to directory

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetECRIdentifier

(

string

ID

)

ECR Identifier number In AshraitEMV , ID must be a number in range of 1:999.

Parameters

[in]

ID

is identifier.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetManufactureID

(

string

ID

)

Manufacture Id in Process.

Parameters

[in]

ID

is a string containing the manufacture ID.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API void Modularity::SPI::Config::SetProcessorID

(

Modularity::SPI::Ashrait::ProcessorId

Id

)

Set your service processor. Using this will load deafult certificate and settings for choosen processor. AshraitEMV service Note: SetProcessorIPAddress() and SetProcessorPortNumber() are still mandatory. Default value is ABS.

Parameters

[in]

Id

is identifier

Returns

void

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetProcessorIPAddress

(

string

IPAddress

)

Set Proccessor IP address directory. For SHVA test envitment set the following address: 193.142.151.62.

Parameters

[in]

IPAddress

is a string containing the IP address of the processor.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetProcessorPortNumber

(

PortType

Port

)

Set Proccessor Port number. For SHVA test envitment calling this method is not necessary.

Parameters

[in]

SetProcessorPortNumber

is integer containing the server port number of the processor.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

---

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

• Config.h