Safir SDK Core
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Safir::Dob::CallbackId::EnumerationContainer Class Reference

#include <Safir/Dob/CallbackId.h>

Inheritance diagram for Safir::Dob::CallbackId::EnumerationContainer:
Collaboration diagram for Safir::Dob::CallbackId::EnumerationContainer:

Public Types

typedef Enumeration ContainedType
 

Public Member Functions

virtual void SetOrdinal (const Safir::Dob::Typesystem::EnumerationValue value)
 Set the ordinal value of the enumeration container. More...
 
virtual
Safir::Dob::Typesystem::EnumerationValue 
GetOrdinal () const
 Get the ordinal value of the enumeration container. More...
 
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
 EnumerationContainerBase ()
 Default Constructor. More...
 
virtual bool IsNull () const
 Is the container set to null? More...
 
virtual void SetNull ()
 Set the container to null. More...
 
virtual void Copy (const ContainerBase &that)
 Virtual assignment. More...
 
- Public Member Functions inherited from Safir::Dob::Typesystem::ContainerBase
 ContainerBase ()
 Default Constructor. More...
 
virtual ~ContainerBase ()
 Virtual destructor. More...
 
virtual bool IsChanged () const
 Is the change flag set on the container? The change flag gets updated every time the contained value changes. More...
 
virtual void SetChanged (const bool changed)
 Set the containers change flag. More...
 

Additional Inherited Members

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

Member Typedef Documentation

Member Function Documentation

virtual Safir::Dob::Typesystem::EnumerationValue Safir::Dob::CallbackId::EnumerationContainer::GetOrdinal ( ) const
virtual

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__.

Enumeration Safir::Dob::CallbackId::EnumerationContainer::GetVal ( ) const
bool Safir::Dob::CallbackId::EnumerationContainer::operator!= ( const Enumeration  other) const
bool Safir::Dob::CallbackId::EnumerationContainer::operator== ( const Enumeration  other) const
virtual void Safir::Dob::CallbackId::EnumerationContainer::SetOrdinal ( const Safir::Dob::Typesystem::EnumerationValue  value)
virtual

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__.

void Safir::Dob::CallbackId::EnumerationContainer::SetVal ( const Enumeration  value)