Bifrost SDK
Bifrost SDK documentation
Bifrost::Geometry::GeoValidator Class Reference

This is the base class for validating geometry. More...

#include <Validator.h>

Inheritance diagram for Bifrost::Geometry::GeoValidator:
Bifrost::Geometry::InstancesValidator Bifrost::Geometry::MeshValidator Bifrost::Geometry::PointCloudValidator Bifrost::Geometry::StrandValidator Bifrost::Geometry::VolumeValidator

Classes

class  Status
 This class contains an error code and an informative text description of an error. More...
 

Public Types

enum class  ErrorCode {
  kNoError = 0 , kInvalidObject , kInvalidProperty , kInvalidSet ,
  kInvalidCount , kInvalidIndex , kMissingTarget , kInvalidTarget
}
 

Public Member Functions

 GeoValidator ()
 
virtual ~GeoValidator ()
 
virtual Status validate (const Bifrost::Object &object)
 Validates the given object. More...
 

Detailed Description

This is the base class for validating geometry.

Definition at line 30 of file Validator.h.

Member Enumeration Documentation

◆ ErrorCode

Error codes that describe errors that may be found when validating objects.

Enumerator
kNoError 
kInvalidObject 
kInvalidProperty 
kInvalidSet 
kInvalidCount 
kInvalidIndex 
kMissingTarget 
kInvalidTarget 

Definition at line 37 of file Validator.h.

Constructor & Destructor Documentation

◆ GeoValidator()

Bifrost::Geometry::GeoValidator::GeoValidator ( )

◆ ~GeoValidator()

virtual Bifrost::Geometry::GeoValidator::~GeoValidator ( )
virtual

Member Function Documentation

◆ validate()

virtual Status Bifrost::Geometry::GeoValidator::validate ( const Bifrost::Object object)
virtual

Validates the given object.

Parameters
[in]objectThe object to validate.
Returns
A status object that indicates the validity of the object.

Reimplemented in Bifrost::Geometry::PointCloudValidator, Bifrost::Geometry::InstancesValidator, Bifrost::Geometry::StrandValidator, Bifrost::Geometry::MeshValidator, and Bifrost::Geometry::VolumeValidator.