PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::System::Commons::Xml::DocumentTraits Class Reference

This class collects several document traits. More...

#include <DocumentTraits.hpp>

Public Types

using Values = std::set< String >
 

Public Member Functions

 DocumentTraits (void)
 Default constructor.
 
 DocumentTraits (const String &value)
 Constructs a DocumentTraits instance. More...
 
 DocumentTraits (const DocumentTraits &arg)
 Default copy constructor.
 
 DocumentTraits (DocumentTraits &&arg) noexcept
 Default move constructor.
 
DocumentTraitsoperator= (const DocumentTraits &arg)
 Default copy-assignment operator.
 
DocumentTraitsoperator= (DocumentTraits &&arg) noexcept
 Default move-assignment operator.
 
 ~DocumentTraits (void)
 Default destructor.
 
void Add (const String &value)
 Adds a trait to this instance. More...
 
bool IsEmpty (void) const
 Determines if this instance is empty. More...
 
bool HasTrait (const String &value) const
 Determines if this instance contains the given trait. More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Detailed Description

This class collects several document traits.

The document traits might be applied insided of XML Include files, to apply one or more traits of a document, depending of the document path.

Constructor & Destructor Documentation

◆ DocumentTraits()

Arp::System::Commons::Xml::DocumentTraits::DocumentTraits ( const String value)
explicit

Constructs a DocumentTraits instance.

Parameters
valueA initial trait value as string.

Member Function Documentation

◆ Add()

void Arp::System::Commons::Xml::DocumentTraits::Add ( const String value)

Adds a trait to this instance.

Parameters
valueThe trait value to add.

◆ HasTrait()

bool Arp::System::Commons::Xml::DocumentTraits::HasTrait ( const String value) const

Determines if this instance contains the given trait.

Returns
true if this instance contains the given trait, otherwise false.

◆ IsEmpty()

bool Arp::System::Commons::Xml::DocumentTraits::IsEmpty ( void  ) const

Determines if this instance is empty.

Returns
true if this instance is empty, otherwise false.

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