PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::Plc::Commons::Gds::StaticString< Capacity, TChar > Class Template Reference

This class represents the counterpart to the data type 'IecString', 'IecWString'. It's the C++ data type which can be used by Arp components or by user programs. More...

#include <StaticString.hxx>

Inheritance diagram for Arp::Plc::Commons::Gds::StaticString< Capacity, TChar >:
Inheritance graph

Public Types

using String = Arp::String
 

Public Member Functions

 StaticString (const TChar *str=nullptr)
 Constructs an StaticString instance.
 
 StaticString (const StaticString &arg)
 Copy constructor.
 
StaticStringoperator= (const StaticString< Capacity, TChar > &arg)
 Assignment operator.
 
template<uint16 M>
StaticStringoperator= (const StaticString< M, TChar > &arg)
 
StaticStringoperator= (const String &arg)
 
StaticStringoperator= (const TChar *arg)
 
 ~StaticString (void)=default
 Destructs this instance and frees all resources.
 
uint16 GetLength (void) const
 
bool IsEmpty (void) const
 
void CopyTo (StaticString &other) const
 
String ToString (void) const
 
void Clear (void)
 
template<uint16 M>
StaticString< N, TChar > & operator= (const StaticString< M, TChar > &arg)
 
- Public Member Functions inherited from Arp::Plc::Commons::Gds::StaticStringBase
 StaticStringBase (uint16 capacityArg=80)
 Constructs an StaticStringBase instance.
 
 StaticStringBase (const StaticStringBase &arg)=default
 Copy constructor.
 
StaticStringBaseoperator= (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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Arp::Plc::Commons::Gds::StaticStringBase
static size_t GetMetaDataSize (void)
 
- Static Protected Member Functions inherited from Arp::Plc::Commons::Gds::StaticStringBase
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 inherited from Arp::Plc::Commons::Gds::StaticStringBase
uint16 capacity
 
uint16 length
 

Detailed Description

template<uint16 Capacity = 80, class TChar = char8>
class Arp::Plc::Commons::Gds::StaticString< Capacity, TChar >

This class represents the counterpart to the data type 'IecString', 'IecWString'. It's the C++ data type which can be used by Arp components or by user programs.


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