Public Member Functions | Public Attributes | Private Member Functions | List of all members
arg_v Struct Reference

#include <cast.h>

Inheritance diagram for arg_v:
Inheritance graph
[legend]

Public Member Functions

template<typename T >
 arg_v (const char *name, T &&x, const char *descr=nullptr)
 Direct construction with name, default, and description. More...
 
template<typename T >
 arg_v (const arg &base, T &&x, const char *descr=nullptr)
 Called internally when invoking py::arg("a") = value More...
 
arg_vnoconvert (bool flag=true)
 Same as arg::noconvert(), but returns *this as arg_v&, not arg&. More...
 
arg_vnone (bool flag=true)
 Same as arg::nonone(), but returns *this as arg_v&, not arg&. More...
 
- Public Member Functions inherited from arg
constexpr arg (const char *name=nullptr)
 
argnoconvert (bool flag=true)
 Indicate that the type should not be converted in the type caster. More...
 
argnone (bool flag=true)
 Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args) More...
 
template<typename T >
arg_v operator= (T &&value) const
 Assign a value to this argument. More...
 

Public Attributes

const char * descr
 The (optional) description of the default value. More...
 
std::string type
 The C++ type name of the default value (only available when compiled in debug mode) More...
 
object value
 The default value. More...
 
- Public Attributes inherited from arg
bool flag_noconvert: 1
 
bool flag_none: 1
 If set (the default), allow None to be passed to this argument. More...
 
const char * name
 If non-null, this is a named kwargs argument. More...
 

Private Member Functions

template<typename T >
 arg_v (arg &&base, T &&x, const char *descr=nullptr)
 

Detailed Description

Annotation for arguments with values

Definition at line 1265 of file cast.h.

Constructor & Destructor Documentation

◆ arg_v() [1/3]

template<typename T >
arg_v::arg_v ( arg &&  base,
T &&  x,
const char *  descr = nullptr 
)
inlineprivate

Definition at line 1268 of file cast.h.

◆ arg_v() [2/3]

template<typename T >
arg_v::arg_v ( const char *  name,
T &&  x,
const char *  descr = nullptr 
)
inline

Direct construction with name, default, and description.

Definition at line 1288 of file cast.h.

◆ arg_v() [3/3]

template<typename T >
arg_v::arg_v ( const arg base,
T &&  x,
const char *  descr = nullptr 
)
inline

Called internally when invoking py::arg("a") = value

Definition at line 1293 of file cast.h.

Member Function Documentation

◆ noconvert()

arg_v& arg_v::noconvert ( bool  flag = true)
inline

Same as arg::noconvert(), but returns *this as arg_v&, not arg&.

Definition at line 1297 of file cast.h.

◆ none()

arg_v& arg_v::none ( bool  flag = true)
inline

Same as arg::nonone(), but returns *this as arg_v&, not arg&.

Definition at line 1303 of file cast.h.

Member Data Documentation

◆ descr

const char* arg_v::descr

The (optional) description of the default value.

Definition at line 1311 of file cast.h.

◆ type

std::string arg_v::type

The C++ type name of the default value (only available when compiled in debug mode)

Definition at line 1314 of file cast.h.

◆ value

object arg_v::value

The default value.

Definition at line 1309 of file cast.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:40:59