NvElement Class Reference

Detailed Description

Every element has a unique name that can be used for identifying the element in debug logs.

NvElement also provides other common functionality, such as keeping track of errors.

Definition at line 63 of file NvElement.h.

Inheritance diagram for NvElement:

Collaboration diagram for NvElement:

Public Member Functions
virtual int	isInError ()
	Indicates whether the element encountered an error during its operation. More...
virtual	~NvElement ()
void	getProfilingData (NvElementProfiler::NvElementProfilerData &data)
	Gets profiling data for the element. More...
void	printProfilingStats (std::ostream &out_stream=std::cout)
	Prints profiling data for the element to an output stream. More...
virtual void	enableProfiling ()
	Enables profiling for the element. More...
bool	isProfilingEnabled ()
	Checks whether profiling is enabled for the element. More...

Protected Member Functions
	NvElement (const char *name, NvElementProfiler::ProfilerField=NvElementProfiler::PROFILER_FIELD_NONE)
	Creates a new NvElement object with name name. More...
	NvElement (const NvElement &that)
	Disallows copy constructor. More...
void	operator= (NvElement const &)
	Disallows assignment. More...

Protected Attributes
int	is_in_error
	Indicates if an error was encountered during the operation of the element. More...
const char *	comp_name
	Specifies the name of the component, for debugging. More...
NvElementProfiler	profiler
	Profiler for the element. More...

Constructor & Destructor Documentation

~NvElement()

virtual NvElement::~NvElement ( )

inlinevirtual

Definition at line 76 of file NvElement.h.

NvElement() [1/2]

NvElement::NvElement ( const char *  name, NvElementProfiler::ProfilerField  = NvElementProfiler::PROFILER_FIELD_NONE  )

protected

Creates a new NvElement object with name name.

If the name parameter is NULL, this method sets the internal error variable.

Parameters

[in]

name

If non-NULL, a pointer to the name of the element.

NvElement() [2/2]

NvElement::NvElement ( const NvElement &  that )

protected

Disallows copy constructor.

Member Function Documentation

enableProfiling()

virtual void NvElement::enableProfiling ( )

virtual

Enables profiling for the element.

Reimplemented in NvV4l2Element.

getProfilingData()

void NvElement::getProfilingData

(

NvElementProfiler::NvElementProfilerData &

data

)

Gets profiling data for the element.

Returns

A constant reference to the element's profiling data.

isInError()

virtual int NvElement::isInError ( )

inlinevirtual

Indicates whether the element encountered an error during its operation.

Returns

0 if no error was encountered, a non-zero value if an error was encountered.

Reimplemented in NvV4l2Element.

Definition at line 72 of file NvElement.h.

References is_in_error.

isProfilingEnabled()

bool NvElement::isProfilingEnabled

(

)

Checks whether profiling is enabled for the element.

Returns

Boolean value indicating if profiling is enabled.

operator=()

void NvElement::operator= ( NvElement const &  )

protected

Disallows assignment.

printProfilingStats()

void NvElement::printProfilingStats

(

std::ostream &

out_stream = std::cout

)

Prints profiling data for the element to an output stream.

Parameters

[in]

out_stream

Output stream of type std::ostream to print the data to. It takes the default value std::cout if not specified.

Field Documentation

comp_name

const char* NvElement::comp_name

protected

Specifies the name of the component, for debugging.

Definition at line 122 of file NvElement.h.

is_in_error

int NvElement::is_in_error

protected

Indicates if an error was encountered during the operation of the element.

Definition at line 120 of file NvElement.h.

Referenced by isInError().

profiler

NvElementProfiler NvElement::profiler

protected

Profiler for the element.

Definition at line 124 of file NvElement.h.

---

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

• multimedia_api/ll_samples/include/NvElement.h