Logo
ApraPipes 1.0
Loading...
Searching...
No Matches
apra::AttrDef Struct Reference

#include <Metadata.h>

Collaboration diagram for apra::AttrDef:
Collaboration graph

Public Types

enum class  Type {
  Integer , Int64 , Floating , Boolean ,
  Text , Enumeration , IntArray
}
 

Public Member Functions

constexpr AttrDef ()=default
 

Static Public Member Functions

static constexpr AttrDef Integer (std::string_view name, bool req=true, std::string_view desc="")
 
static constexpr AttrDef Int64 (std::string_view name, bool req=true, std::string_view desc="")
 
static constexpr AttrDef Floating (std::string_view name, bool req=true, std::string_view desc="")
 
static constexpr AttrDef Boolean (std::string_view name, bool req=true, std::string_view desc="")
 
static constexpr AttrDef Text (std::string_view name, bool req=true, std::string_view desc="")
 
static constexpr AttrDef Enum (std::string_view name, std::string_view v1, std::string_view v2, bool req=true, std::string_view desc="")
 
static constexpr AttrDef Enum (std::string_view name, std::string_view v1, std::string_view v2, std::string_view v3, std::string_view v4, bool req=true, std::string_view desc="")
 
static constexpr AttrDef IntArray (std::string_view name, bool req=true, std::string_view desc="")
 

Public Attributes

std::string_view name
 
Type type = Type::Integer
 
bool required = true
 
std::array< std::string_view, MAX_ENUM_VALUESenum_values {}
 
size_t enum_value_count = 0
 
std::string_view description = ""
 

Member Enumeration Documentation

◆ Type

enum class apra::AttrDef::Type
strong
Enumerator
Integer 
Int64 
Floating 
Boolean 
Text 
Enumeration 
IntArray 

Constructor & Destructor Documentation

◆ AttrDef()

apra::AttrDef::AttrDef ( )
constexprdefault

Member Function Documentation

◆ Boolean()

static constexpr AttrDef apra::AttrDef::Boolean ( std::string_view name,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ Enum() [1/2]

static constexpr AttrDef apra::AttrDef::Enum ( std::string_view name,
std::string_view v1,
std::string_view v2,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ Enum() [2/2]

static constexpr AttrDef apra::AttrDef::Enum ( std::string_view name,
std::string_view v1,
std::string_view v2,
std::string_view v3,
std::string_view v4,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ Floating()

static constexpr AttrDef apra::AttrDef::Floating ( std::string_view name,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ Int64()

static constexpr AttrDef apra::AttrDef::Int64 ( std::string_view name,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ IntArray()

static constexpr AttrDef apra::AttrDef::IntArray ( std::string_view name,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ Integer()

static constexpr AttrDef apra::AttrDef::Integer ( std::string_view name,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

◆ Text()

static constexpr AttrDef apra::AttrDef::Text ( std::string_view name,
bool req = true,
std::string_view desc = "" )
inlinestaticconstexpr

Member Data Documentation

◆ description

std::string_view apra::AttrDef::description = ""

◆ enum_value_count

size_t apra::AttrDef::enum_value_count = 0

◆ enum_values

std::array<std::string_view, MAX_ENUM_VALUES> apra::AttrDef::enum_values {}

◆ name

std::string_view apra::AttrDef::name

◆ required

bool apra::AttrDef::required = true

◆ type

Type apra::AttrDef::type = Type::Integer

The documentation for this struct was generated from the following file: