Arp::Plc::Commons::Gds::StaticStringBase Class Reference

This class is the base class used for 'IecString' and 'StaticString'. More...

#include <StaticStringBase.hpp>

Inheritance diagram for Arp::Plc::Commons::Gds::StaticStringBase:

Public Member Functions
	StaticStringBase (uint16 capacityArg=80)
	Constructs an StaticStringBase instance. More...
	StaticStringBase (const StaticStringBase &arg)=default
	Copy constructor. More...
StaticStringBase &	operator= (const StaticStringBase &arg)=default
	Assignment operator. More...
	~StaticStringBase (void)=default
	Destructs this instance and frees all resources. More...
uint16	GetCapacity (void) const
uint16	GetLength (void) const
char8 *	GetData (void) const
char16 *	GetData16 (void) const
size_t	GetSize (void) const
size_t	GetSize (DataType dataType) const
size_t	GetSize (size_t charSize) const
void	CopyTo (StaticStringBase &other) const

Static Public Member Functions
static size_t	GetMetaDataSize (void)

Static Protected Member Functions
static uint16	AssignStaticString (char8 *pData, uint16 capacity, const String &arg)
	Assigns an Arp::String to a StaticString(char8) object More...
static uint16	AssignStaticString (char16 *pData, uint16 capacity, const String &arg)
	Assigns an Arp::String to a StaticString(char16) object More...
static String	ConvertStaticString (const char8 *pData)
	Converts a StaticString(char8) object into an Arp::String More...
static String	ConvertStaticString (const char16 *pData)
	Converts a StaticString(char16) object into an Arp::String More...

Protected Attributes
uint16	capacity
uint16	length

Detailed Description

This class is the base class used for 'IecString' and 'StaticString'.

Constructor & Destructor Documentation

StaticStringBase() [1/2]

Arp::Plc::Commons::Gds::StaticStringBase::StaticStringBase

(

uint16

capacityArg = 80

)

Constructs an StaticStringBase instance.

StaticStringBase() [2/2]

Arp::Plc::Commons::Gds::StaticStringBase::StaticStringBase ( const StaticStringBase &  arg )

default

Copy constructor.

~StaticStringBase()

Arp::Plc::Commons::Gds::StaticStringBase::~StaticStringBase ( void  )

default

Destructs this instance and frees all resources.

Member Function Documentation

AssignStaticString() [1/2]

static uint16 Arp::Plc::Commons::Gds::StaticStringBase::AssignStaticString ( char16 *  pData, uint16  capacity, const String &  arg  )

staticprotected

Assigns an Arp::String to a StaticString(char16) object

Parameters

pData	Pointer to destination character string char16
capacity	Capacity of destination character string
arg	Source Arp::String object

Returns

Length of the assigned string

AssignStaticString() [2/2]

static uint16 Arp::Plc::Commons::Gds::StaticStringBase::AssignStaticString ( char8 *  pData, uint16  capacity, const String &  arg  )

staticprotected

Assigns an Arp::String to a StaticString(char8) object

Parameters

pData	Pointer to destination character string char8
capacity	Capacity of destination character string
arg	Source Arp::String object

Returns

Length of the assigned string

ConvertStaticString() [1/2]

static String Arp::Plc::Commons::Gds::StaticStringBase::ConvertStaticString ( const char16 *  pData )

staticprotected

Converts a StaticString(char16) object into an Arp::String

Parameters

pData

Pointer to source character string char16

Returns

Converted Arp::String object

ConvertStaticString() [2/2]

static String Arp::Plc::Commons::Gds::StaticStringBase::ConvertStaticString ( const char8 *  pData )

staticprotected

Converts a StaticString(char8) object into an Arp::String

Parameters

pData

Pointer to source character string char8

Returns

Converted Arp::String object

operator=()

StaticStringBase& Arp::Plc::Commons::Gds::StaticStringBase::operator= ( const StaticStringBase &  arg )

default

Assignment operator.

---

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

• Arp/Plc/Commons/Gds/StaticStringBase.hpp