apra Namespace Reference

Namespaces
namespace	detail
namespace	patterns

Classes
struct	AnalysisError
struct	AnalysisResult
struct	AttrDef
struct	BridgeSpec
class	CompositeValidator
struct	Connection
struct	ConnectionInfo
class	EnumValidator
struct	FrameTypeDef
struct	FrameTypeInfo
class	FrameTypeRegistry
struct	Issue
class	JsonParser
class	ModuleFactory
struct	ModuleInfo
struct	ModuleInstance
class	ModuleRegistrationBuilder
class	ModuleRegistry
struct	ParseResult
struct	PinDef
class	PipelineAnalyzer
struct	PipelineDescription
struct	PipelineSettings
class	PipelineValidator
struct	PropDef
struct	PropertyInfo
class	PropertyValidator
class	PropertyValidatorRegistry
class	RangeValidator
class	RegexValidator
struct	Suggestion
struct	TypeConversion
struct	ValidationResult
struct	Warning

Typedefs
using	ValidationIssue = Issue
using	BuildIssue = Issue
using	MemType = FrameMetadata::MemType
using	ImageType = ImageMetadata::ImageType
using	DynamicPropertyAccessors = ModuleInfo::PropertyAccessors
using	ScalarPropertyValue
using	PropertyValue
using	IntRangeValidator = RangeValidator<int64_t>
using	FloatRangeValidator = RangeValidator<double>
using	json = nlohmann::json

Enumerations
enum class	ModuleCategory {   Source , Sink , Transform , Analytics ,   Controller , Utility }
enum class	BridgeType { Memory , Format }
enum class	MemoryDirection { HostToDevice , DeviceToHost }

Functions
void	ensureBuiltinFrameTypesRegistered ()
std::string	demangleTypeName (const char *mangledName)
std::string	extractClassName (const std::string &fullName)
template<typename ModuleClass , typename PropsClass >
ModuleRegistrationBuilder< ModuleClass, PropsClass >	registerModule ()
template<typename ModuleClass >
ModuleRegistrationBuilder< ModuleClass, ModuleProps >	registerModule ()
template<typename ModuleClass , typename PropsClass , typename CudaFactoryLambda >
void	setCudaModuleFactory (const std::string &moduleName, CudaFactoryLambda &&cudaFactory)
void	ensureBuiltinModulesRegistered ()
template<typename T >
T	getProperty (const std::map< std::string, PropertyValue > &props, const std::string &key, const T &defaultValue)
std::string	propertyValueToString (const PropertyValue &value)
template<typename T >
void	applyProp (T &member, const char *propName, const std::map< std::string, ScalarPropertyValue > &values, bool isRequired, std::vector< std::string > &missingRequired)
template<typename T >
ScalarPropertyValue	toPropertyValue (const T &member)
template<typename T >
bool	applyFromVariant (T &member, const ScalarPropertyValue &value)
template<typename T >
std::shared_ptr< RangeValidator< T > >	makeRangeValidator (T min, T max)
std::shared_ptr< RegexValidator >	makeRegexValidator (const std::string &pattern, const std::string &description="")
std::shared_ptr< EnumValidator >	makeEnumValidator (std::initializer_list< std::string > values, bool caseSensitive=true)
static void *	createCudaStream ()
static void *	createCuContext ()
static const TypeConversion *	findTypeConversion (const std::string &srcType, const std::string &dstType)
static std::string	generateBridgeModuleName (const std::string &fromModule, const std::string &toModule)
static std::string	generateTomlSnippet (const std::string &fromModule, const std::string &toModule, const TypeConversion &conv)
static FrameMetadata::FrameType	stringToFrameType (const std::string &typeStr)
static const TypeConversion *	findTypeConversion (const std::string &srcType, const std::string &dstType)
static std::string	generateBridgeModuleName (const std::string &fromModule, const std::string &toModule, const TypeConversion &conv)
static std::string	generateTomlSnippet (const std::string &fromModule, const std::string &toModule, const TypeConversion &conv)

Variables
constexpr size_t	MAX_FRAME_TYPES = 8
constexpr size_t	MAX_IMAGE_TYPES = 8
constexpr size_t	MAX_ENUM_VALUES = 16
static const std::vector< TypeConversion >	KNOWN_CONVERSIONS
static const std::vector< TypeConversion >	KNOWN_CONVERSIONS

Typedef Documentation

BuildIssue

using apra::BuildIssue = Issue

DynamicPropertyAccessors

using apra::DynamicPropertyAccessors = ModuleInfo::PropertyAccessors

FloatRangeValidator

using apra::FloatRangeValidator = RangeValidator<double>

ImageType

using apra::ImageType = ImageMetadata::ImageType

IntRangeValidator

using apra::IntRangeValidator = RangeValidator<int64_t>

json

using apra::json = nlohmann::json

MemType

using apra::MemType = FrameMetadata::MemType

PropertyValue

using apra::PropertyValue

Initial value:

 std::variant<
    int64_t,
    double,
    bool,
    std::string,
    std::vector<int64_t>,
    std::vector<double>,
    std::vector<std::string>
>

ScalarPropertyValue

typedef std::variant< int64_t, double, bool, std::string > apra::ScalarPropertyValue

Initial value:

 std::variant<
    int64_t,
    double,
    bool,
    std::string
>

ValidationIssue

using apra::ValidationIssue = Issue

Enumeration Type Documentation

BridgeType

enum class apra::BridgeType

strong

Enumerator
Memory
Format

MemoryDirection

enum class apra::MemoryDirection

strong

Enumerator
HostToDevice
DeviceToHost

ModuleCategory

enum class apra::ModuleCategory

strong

Enumerator
Source
Sink
Transform
Analytics
Controller
Utility

Function Documentation

applyFromVariant()

template<typename T >

bool apra::applyFromVariant ( T & member, const ScalarPropertyValue & value )

inline

Here is the caller graph for this function:

applyProp()

template<typename T >

void apra::applyProp ( T & member, const char * propName, const std::map< std::string, ScalarPropertyValue > & values, bool isRequired, std::vector< std::string > & missingRequired )

inline

Here is the caller graph for this function:

createCuContext()

static void * apra::createCuContext ( )

static

Here is the caller graph for this function:

createCudaStream()

static void * apra::createCudaStream ( )

static

Here is the caller graph for this function:

demangleTypeName()

std::string apra::demangleTypeName ( const char * mangledName )

inline

Here is the caller graph for this function:

ensureBuiltinFrameTypesRegistered()

void apra::ensureBuiltinFrameTypesRegistered

(

)

Here is the call graph for this function:

ensureBuiltinModulesRegistered()

void apra::ensureBuiltinModulesRegistered

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

extractClassName()

std::string apra::extractClassName ( const std::string & fullName )

inline

Here is the caller graph for this function:

findTypeConversion() [1/2]

static const TypeConversion * apra::findTypeConversion ( const std::string & srcType, const std::string & dstType )

static

Here is the caller graph for this function:

findTypeConversion() [2/2]

static const TypeConversion * apra::findTypeConversion ( const std::string & srcType, const std::string & dstType )

static

generateBridgeModuleName() [1/2]

static std::string apra::generateBridgeModuleName ( const std::string & fromModule, const std::string & toModule )

static

Here is the caller graph for this function:

generateBridgeModuleName() [2/2]

static std::string apra::generateBridgeModuleName ( const std::string & fromModule, const std::string & toModule, const TypeConversion & conv )

static

generateTomlSnippet() [1/2]

static std::string apra::generateTomlSnippet ( const std::string & fromModule, const std::string & toModule, const TypeConversion & conv )

static

Here is the call graph for this function:

Here is the caller graph for this function:

generateTomlSnippet() [2/2]

static std::string apra::generateTomlSnippet ( const std::string & fromModule, const std::string & toModule, const TypeConversion & conv )

static

Here is the call graph for this function:

getProperty()

template<typename T >

T apra::getProperty	(	const std::map< std::string, PropertyValue > &	props,
		const std::string &	key,
		const T &	defaultValue )

makeEnumValidator()

std::shared_ptr< EnumValidator > apra::makeEnumValidator ( std::initializer_list< std::string > values, bool caseSensitive = true )

inline

makeRangeValidator()

template<typename T >

std::shared_ptr< RangeValidator< T > > apra::makeRangeValidator ( T min, T max )

inline

makeRegexValidator()

std::shared_ptr< RegexValidator > apra::makeRegexValidator ( const std::string & pattern, const std::string & description = "" )

inline

propertyValueToString()

std::string apra::propertyValueToString

(

const PropertyValue &

value

)

Here is the caller graph for this function:

registerModule() [1/2]

template<typename ModuleClass , typename PropsClass >

ModuleRegistrationBuilder< ModuleClass, PropsClass > apra::registerModule

(

)

Here is the caller graph for this function:

registerModule() [2/2]

template<typename ModuleClass >

ModuleRegistrationBuilder< ModuleClass, ModuleProps > apra::registerModule

(

)

setCudaModuleFactory()

template<typename ModuleClass , typename PropsClass , typename CudaFactoryLambda >

void apra::setCudaModuleFactory	(	const std::string &	moduleName,
		CudaFactoryLambda &&	cudaFactory )

Here is the call graph for this function:

stringToFrameType()

static FrameMetadata::FrameType apra::stringToFrameType ( const std::string & typeStr )

static

Here is the caller graph for this function:

toPropertyValue()

template<typename T >

ScalarPropertyValue apra::toPropertyValue ( const T & member )

inline

Variable Documentation

KNOWN_CONVERSIONS [1/2]

const std::vector<TypeConversion> apra::KNOWN_CONVERSIONS

static

Initial value:

= {
    
    {"RawImagePlanar", "RawImage", "ColorConversion", {{"conversionType", "YUV420PLANAR_TO_RGB"}}},
 
    
    {"RawImage", "RawImagePlanar", "ColorConversion", {{"conversionType", "RGB_TO_YUV420PLANAR"}}},
 
    
    {"EncodedImage", "RawImage", "ImageDecoderCV", {}},
    {"H264Data", "RawImagePlanar", "H264Decoder", {}},
    {"H264Frame", "RawImagePlanar", "H264Decoder", {}},
 
    
    {"RawImage", "EncodedImage", "ImageEncoderCV", {}},
}

KNOWN_CONVERSIONS [2/2]

const std::vector<TypeConversion> apra::KNOWN_CONVERSIONS

static

Initial value:

= {
    
    {"RawImagePlanar", "RawImage", "ColorConversion", {{"conversionType", "YUV420PLANAR_TO_RGB"}}},
 
    
    {"RawImage", "RawImagePlanar", "ColorConversion", {{"conversionType", "RGB_TO_YUV420PLANAR"}}},
 
    
    {"EncodedImage", "RawImage", "ImageDecoderCV", {}},
    {"H264Data", "RawImagePlanar", "H264Decoder", {}},
 
    
    {"RawImage", "EncodedImage", "ImageEncoderCV", {}},
}

MAX_ENUM_VALUES

size_t apra::MAX_ENUM_VALUES = 16

inlineconstexpr

MAX_FRAME_TYPES

size_t apra::MAX_FRAME_TYPES = 8

inlineconstexpr

MAX_IMAGE_TYPES

size_t apra::MAX_IMAGE_TYPES = 8

inlineconstexpr