stormm::docs::ObjectIdentifier Class Reference

Stores data on instances of an object (i.e. a function or struct found in a given file. More...

#include <code_dox.h>

Public Member Functions
	ObjectIdentifier (const std::string &filename_in)
	Constructor for the ObjectIdentifier struct.
	~ObjectIdentifier ()=default
	Default destructor.
int	getInstanceCount () const
	Return the number of instances for an object, as recorded in some ObjectIdentifier.
const std::string	getFileName () const
	Return the name of the file searched to produce an ObjectIdentifier.
int	getReturnTypeCount () const
	Report the number of return types for an object from some ObjectIdentifier.
const std::string	getReturnType (const int nt=0) const
	Report the return type found for an object, as recorded in some ObjectIdentifier.
void	addInstance (const int n_add=1)
	Tally one more instance of an object in an ObjectIdentifier.
void	addReturnType (const std::string rtype)
	Set the return type of an object in an ObjectIdentifier.

Detailed Description

Stores data on instances of an object (i.e. a function or struct found in a given file.

Constructor & Destructor Documentation

ObjectIdentifier()

stormm::docs::ObjectIdentifier::ObjectIdentifier

(

const std::string &

filename_in

)

Constructor for the ObjectIdentifier struct.

Parameters

filename_in

Name of the file being searched

Member Function Documentation

addInstance()

void stormm::docs::ObjectIdentifier::addInstance

(

const int

n_add = 1

)

Tally one more instance of an object in an ObjectIdentifier.

Parameters

n_add

The number of new instances to tally

getReturnType()

const std::string stormm::docs::ObjectIdentifier::getReturnType

(

const int

nt = 0

)

const

Report the return type found for an object, as recorded in some ObjectIdentifier.

Parameters

nt	The index of the return type to return

---

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

• src/Reporting/code_dox.h
• src/Reporting/code_dox.cpp