RAMSES Documentation  27.0.130
Information for RAMSES users and developers
StatusObject.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2014 BMW Car IT GmbH
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_STATUSOBJECT_H
10 #define RAMSES_STATUSOBJECT_H
11 
14 #include "EValidationSeverity.h"
15 
16 namespace ramses
17 {
22  {
23  public:
34  status_t validate() const;
35 
49 
57  const char* getStatusMessage(status_t status) const;
58 
62  class StatusObjectImpl& impl;
63 
68  StatusObject(const StatusObject& other) = delete;
69 
75  StatusObject& operator=(const StatusObject& other) = delete;
76 
77  protected:
83  explicit StatusObject(StatusObjectImpl& pimpl);
84 
88  virtual ~StatusObject();
89  };
90 }
91 
92 #endif // RAMSES_STATUSOBJECT_H
#define RAMSES_API
Definition: APIExport.h:35
The StatusObject provides status message handling.
Definition: StatusObject.h:22
StatusObject(const StatusObject &other)=delete
Deleted copy constructor.
StatusObject(StatusObjectImpl &pimpl)
Constructor for StatusObject.
status_t validate() const
Generates verbose validation of the object.
const char * getStatusMessage(status_t status) const
Get the string description for a status provided by a RAMSES API function.
class StatusObjectImpl & impl
Definition: StatusObject.h:62
StatusObject & operator=(const StatusObject &other)=delete
Deleted copy assignment.
const char * getValidationReport(EValidationSeverity minSeverity=EValidationSeverity_Info) const
Provides verbose report in human readable form generated by validate.
virtual ~StatusObject()
Destructor of the StatusObject.
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15
EValidationSeverity
The EValidationSeverity defines severity of validation results.
Definition: EValidationSeverity.h:18
@ EValidationSeverity_Info
Definition: EValidationSeverity.h:19
uint32_t status_t
Status is a handle to the result of an API call.
Definition: RamsesFrameworkTypes.h:26