Safir SDK Core
Loading...
Searching...
No Matches
Safir::Utilities::ForEach::ResponseType::EnumerationContainer Class Reference

#include </home/lars/safir/safir-sdk-core/src/safir_dou/gen/cpp/include/Safir/Utilities/ForEach/ResponseType.h>

Inheritance diagram for Safir::Utilities::ForEach::ResponseType::EnumerationContainer:
[legend]
Collaboration diagram for Safir::Utilities::ForEach::ResponseType::EnumerationContainer:
[legend]

Public Types

typedef Enumeration ContainedType
 

Public Member Functions

void SetOrdinal (const Safir::Dob::Typesystem::EnumerationValue value) override
 Set the ordinal value of the enumeration container.
 
Safir::Dob::Typesystem::EnumerationValue GetOrdinal () const override
 Get the ordinal value of the enumeration container.
 
void SetVal (const Enumeration value)
 
Enumeration GetVal () const
 
bool operator== (const Enumeration other) const
 
bool operator!= (const Enumeration other) const
 
- Public Member Functions inherited from Safir::Dob::Typesystem::EnumerationContainerBase
constexpr EnumerationContainerBase ()
 Default Constructor.
 
bool IsNull () const override
 Is the container set to null?
 
void SetNull () override
 Set the container to null.
 
void Copy (const ContainerBase &that) override
 Virtual assignment.
 
- Public Member Functions inherited from Safir::Dob::Typesystem::ContainerBase
constexpr ContainerBase ()
 Default Constructor.
 
constexpr ContainerBase (const ContainerBase &)=default
 Copy constructor.
 
virtual ~ContainerBase ()
 Virtual destructor.
 
virtual bool IsChanged () const
 Is the change flag set on the container?
 
virtual void SetChanged (const bool changed)
 Set the containers change flag.
 

Additional Inherited Members

- Protected Member Functions inherited from Safir::Dob::Typesystem::EnumerationContainerBase
constexpr EnumerationContainerBase (const EnumerationContainerBase &other)=default
 Copy constructor.
 
EnumerationContainerBaseoperator= (const EnumerationContainerBase &other)=default
 Copy assignment operator.
 
- Protected Member Functions inherited from Safir::Dob::Typesystem::ContainerBase
ContainerBaseoperator= (const ContainerBase &other)
 Copy assignment operator.
 
- Protected Attributes inherited from Safir::Dob::Typesystem::EnumerationContainerBase
bool m_bIsNull
 The null flag for the enumeration container.
 
EnumerationValue m_Value
 The value of the enumeration container.
 
- Protected Attributes inherited from Safir::Dob::Typesystem::ContainerBase
bool m_bIsChanged
 The variable containing the change flag.
 

Member Typedef Documentation

◆ ContainedType

Member Function Documentation

◆ GetOrdinal()

Safir::Dob::Typesystem::EnumerationValue Safir::Utilities::ForEach::ResponseType::EnumerationContainer::GetOrdinal ( ) const
overridevirtual

Get the ordinal value of the enumeration container.

Note: Only applications that need to use "anonymous enums" should use this method. All other applications should be using the GetVal method.

Returns
The ordinal value of the container.
Exceptions
NullExceptionThe container is null.

Implements Safir::Dob::Typesystem::EnumerationContainerBase.

References __WFILE__.

◆ GetVal()

Enumeration Safir::Utilities::ForEach::ResponseType::EnumerationContainer::GetVal ( ) const

◆ operator!=()

bool Safir::Utilities::ForEach::ResponseType::EnumerationContainer::operator!= ( const Enumeration other) const

◆ operator==()

bool Safir::Utilities::ForEach::ResponseType::EnumerationContainer::operator== ( const Enumeration other) const

◆ SetOrdinal()

void Safir::Utilities::ForEach::ResponseType::EnumerationContainer::SetOrdinal ( const Safir::Dob::Typesystem::EnumerationValue value)
overridevirtual

Set the ordinal value of the enumeration container.

Note: Only applications that need to use "anonymous enums" should use this method. All other applications should be using the SetVal method.

Parameters
value[in] - The new value.
Exceptions
IllegalValueExceptionThe value is not in the range of the enumeration.

Implements Safir::Dob::Typesystem::EnumerationContainerBase.

References __WFILE__.

◆ SetVal()

void Safir::Utilities::ForEach::ResponseType::EnumerationContainer::SetVal ( const Enumeration value)