www.mooseframework.org
Public Attributes | List of all members
RegistryEntry Struct Reference

Holds details and meta-data info for a particular MooseObject or Action for use in the registry. More...

#include <Registry.h>

Public Attributes

std::string _label
 label (usually app name - e.g. "YourAnimalApp") that the object or action is associated with. More...
 
std::string _classname
 name of the c++ class for the object. More...
 
std::string _alias
 an alternate name to register the object to factories under. More...
 
std::string _name
 name that the object will be registered to factories under. If unspecified, _alias is used. More...
 
buildPtr _build_ptr
 function pointer for building instances of the MooseObject (if the entry is for an object). More...
 
buildActionPtr _build_action_ptr
 function pointer for building instances of the Action (if the entry is for an action). More...
 
paramsPtr _params_ptr
 function pointer for building InputParameters objects for the object or action. More...
 
std::string _file
 file path for the c++ file the object or action was added to the registry in. More...
 
int _line
 line number in the c++ file the object or action was added to the registry on. More...
 
std::string _deprecated_time
 time in "mm/dd/yyyy HH:MM" format that the object is/becomes deprecated, blank otherwise. More...
 
std::string _replaced_by
 class name for an object that replaces this object if deprecated, blank otherwise. More...
 
bool _is_ad
 if or not this obect is an AD object More...
 

Detailed Description

Holds details and meta-data info for a particular MooseObject or Action for use in the registry.

Definition at line 144 of file Registry.h.

Member Data Documentation

◆ _alias

std::string RegistryEntry::_alias

an alternate name to register the object to factories under.

If unspecified, _classname is used.

Definition at line 152 of file Registry.h.

◆ _build_action_ptr

buildActionPtr RegistryEntry::_build_action_ptr

function pointer for building instances of the Action (if the entry is for an action).

Definition at line 158 of file Registry.h.

Referenced by Registry::addAction().

◆ _build_ptr

buildPtr RegistryEntry::_build_ptr

function pointer for building instances of the MooseObject (if the entry is for an object).

Definition at line 156 of file Registry.h.

Referenced by Registry::add().

◆ _classname

std::string RegistryEntry::_classname

name of the c++ class for the object.

Definition at line 149 of file Registry.h.

◆ _deprecated_time

std::string RegistryEntry::_deprecated_time

time in "mm/dd/yyyy HH:MM" format that the object is/becomes deprecated, blank otherwise.

Definition at line 166 of file Registry.h.

◆ _file

std::string RegistryEntry::_file

file path for the c++ file the object or action was added to the registry in.

Definition at line 162 of file Registry.h.

◆ _is_ad

bool RegistryEntry::_is_ad

if or not this obect is an AD object

Definition at line 170 of file Registry.h.

◆ _label

std::string RegistryEntry::_label

label (usually app name - e.g. "YourAnimalApp") that the object or action is associated with.

Definition at line 147 of file Registry.h.

Referenced by Registry::addActionInner(), and Registry::addInner().

◆ _line

int RegistryEntry::_line

line number in the c++ file the object or action was added to the registry on.

Definition at line 164 of file Registry.h.

◆ _name

std::string RegistryEntry::_name

name that the object will be registered to factories under. If unspecified, _alias is used.

Definition at line 154 of file Registry.h.

◆ _params_ptr

paramsPtr RegistryEntry::_params_ptr

function pointer for building InputParameters objects for the object or action.

Definition at line 160 of file Registry.h.

Referenced by Registry::add(), and Registry::addAction().

◆ _replaced_by

std::string RegistryEntry::_replaced_by

class name for an object that replaces this object if deprecated, blank otherwise.

Definition at line 168 of file Registry.h.


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