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.
	StaticStringBase (const StaticStringBase &arg)=default
	Copy constructor.
StaticStringBase &	operator= (const StaticStringBase &arg)=default
	Assignment operator.
	~StaticStringBase (void)=default
	Destructs this instance and frees all resources.
uint16	GetCapacity (void) const
uint16	GetLength (void) const
char8 *	GetData (void) const
char16 *	GetData16 (void) const
size_t	GetSize (void) const
	Deprecated! More...
size_t	GetSize (DataType dataType) const
size_t	GetSize (size_t charSize) const
void	CopyTo (StaticStringBase &other) const
	Deprecated! More...

Static Public Member Functions
static size_t	GetMetaDataSize (void)

Static Protected Member Functions
static uint16	AssignStaticString (char8 *pDest, uint16 destCapacity, const String &input)
	Assigns an Arp::String to a StaticString(char8) object More...
static uint16	AssignStaticString (char16 *pDest, uint16 destCapacity, const String &input)
	Assigns an Arp::String to a StaticString(char16) object More...
static String	ConvertStaticString (const char8 *pInput)
	Converts a StaticString(char8) object into an Arp::String More...
static String	ConvertStaticString (const char16 *pInput)
	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'.

Member Function Documentation

AssignStaticString() [1/2]

uint16 Arp::Plc::Commons::Gds::StaticStringBase::AssignStaticString ( char16 *  pDest, uint16  destCapacity, const String &  input  )

staticprotected

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

Parameters

pDest	Pointer to destination character string char16
destCapacity	Capacity of destination character string
input	Source Arp::String object

Returns

Length of the assigned string

AssignStaticString() [2/2]

uint16 Arp::Plc::Commons::Gds::StaticStringBase::AssignStaticString ( char8 *  pDest, uint16  destCapacity, const String &  input  )

staticprotected

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

Parameters

pDest	Pointer to destination character string char8
destCapacity	Capacity of destination character string
input	Source Arp::String object

Returns

Length of the assigned string

ConvertStaticString() [1/2]

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

staticprotected

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

Parameters

pInput

Pointer to source character string char16

Returns

Converted Arp::String object

ConvertStaticString() [2/2]

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

staticprotected

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

Parameters

pInput

Pointer to source character string char8

Returns

Converted Arp::String object

CopyTo()

void Arp::Plc::Commons::Gds::StaticStringBase::CopyTo

(

StaticStringBase &

other

)

const

Deprecated!

Deprecated:

Please use StaticString::CopyTo(StaticString& other), this operation does not support WString

GetSize()

size_t Arp::Plc::Commons::Gds::StaticStringBase::GetSize

(

void

)

const

Deprecated!

Deprecated:

Please use GetSize(DataType), this operation does not support WString

---

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

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