Public Member Functions | Static Public Member Functions | Private Attributes
dynamicCodeContext Class Reference

Encapsulation of dynamic code dictionaries. More...

Collaboration diagram for dynamicCodeContext:
Collaboration graph
[legend]

Public Member Functions

 dynamicCodeContext (const dictionary &)
 Construct from a dictionary. More...
 
const dictionary & dict () const
 Return the parent dictionary context. More...
 
const string & include () const
 Return the code-includes. More...
 
const string & options () const
 Return the code-options. More...
 
const string & libs () const
 Return the code-libs. More...
 
const string & code () const
 Return the code. More...
 
const string & localCode () const
 Return the local (file-scope) code. More...
 
const SHA1Digest & sha1 () const
 Return SHA1 digest calculated from include, options, code. More...
 

Static Public Member Functions

static void addLineDirective (string &, const label lineNum, const fileName &name)
 Helper: add #line directive. More...
 

Private Attributes

const dictionary & dict_
 The parent dictionary context. More...
 
string code_
 Mandatory "code" entry. More...
 
string localCode_
 Optional "localCode" entry. More...
 
string include_
 Optional "codeInclude" entry. More...
 
string options_
 Optional "codeOptions" entry. More...
 
string libs_
 Optional "codeLib" entry. More...
 
SHA1Digest sha1_
 Calculated SHA1Digest. More...
 

Detailed Description

Encapsulation of dynamic code dictionaries.

Source files

Definition at line 49 of file dynamicCodeContext.H.

Constructor & Destructor Documentation

◆ dynamicCodeContext()

dynamicCodeContext ( const dictionary &  dict)

Construct from a dictionary.

Definition at line 33 of file dynamicCodeContext.C.

References dynamicCodeContext::addLineDirective(), dynamicCodeContext::code_, dynamicCodeContext::dict(), OSHA1stream::digest(), dynamicCodeContext::include_, Foam::stringOps::inplaceExpand(), dynamicCodeContext::libs_, dynamicCodeContext::localCode_, dictionary::lookupEntry(), dictionary::lookupEntryPtr(), dictionaryName::name(), dynamicCodeContext::options_, dynamicCodeContext::sha1_, entry::startLineNumber(), entry::stream(), and Foam::stringOps::trim().

Here is the call graph for this function:

Member Function Documentation

◆ dict()

const dictionary& dict ( ) const
inline

Return the parent dictionary context.

Definition at line 84 of file dynamicCodeContext.H.

References dynamicCodeContext::dict_.

Referenced by codedBase::createLibrary(), dynamicCodeContext::dynamicCodeContext(), and codedBase::updateLibrary().

Here is the caller graph for this function:

◆ include()

const string& include ( ) const
inline

Return the code-includes.

Definition at line 90 of file dynamicCodeContext.H.

References dynamicCodeContext::include_.

Referenced by dynamicCode::setFilterContext().

Here is the caller graph for this function:

◆ options()

const string& options ( ) const
inline

Return the code-options.

Definition at line 96 of file dynamicCodeContext.H.

References dynamicCodeContext::options_.

Referenced by codeStream::getFunction(), codedFunctionObject::prepare(), codedFixedValuePointPatchField< Type >::prepare(), codedFixedValueFvPatchField< Type >::prepare(), codedMixedFvPatchField< Type >::prepare(), and CodedSource< Type >::prepare().

Here is the caller graph for this function:

◆ libs()

const string& libs ( ) const
inline

Return the code-libs.

Definition at line 102 of file dynamicCodeContext.H.

References dynamicCodeContext::libs_.

Referenced by codeStream::getFunction(), codedFunctionObject::prepare(), codedFixedValuePointPatchField< Type >::prepare(), codedFixedValueFvPatchField< Type >::prepare(), codedMixedFvPatchField< Type >::prepare(), and CodedSource< Type >::prepare().

Here is the caller graph for this function:

◆ code()

const string& code ( ) const
inline

Return the code.

Definition at line 108 of file dynamicCodeContext.H.

References dynamicCodeContext::code_.

Referenced by dynamicCode::setFilterContext().

Here is the caller graph for this function:

◆ localCode()

const string& localCode ( ) const
inline

Return the local (file-scope) code.

Definition at line 114 of file dynamicCodeContext.H.

References dynamicCodeContext::localCode_.

Referenced by dynamicCode::setFilterContext().

Here is the caller graph for this function:

◆ sha1()

const SHA1Digest& sha1 ( ) const
inline

Return SHA1 digest calculated from include, options, code.

Definition at line 120 of file dynamicCodeContext.H.

References dynamicCodeContext::sha1_.

Referenced by codeStream::getFunction(), dynamicCode::setFilterContext(), codedBase::updateLibrary(), and dynamicCode::upToDate().

Here is the caller graph for this function:

◆ addLineDirective()

void addLineDirective ( string &  code,
const label  lineNum,
const fileName &  name 
)
static

Helper: add #line directive.

Definition at line 128 of file dynamicCodeContext.C.

References Foam::name().

Referenced by dynamicCodeContext::dynamicCodeContext(), and codedFunctionObject::read().

Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ dict_

const dictionary& dict_
private

The parent dictionary context.

Definition at line 54 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::dict().

◆ code_

string code_
private

Mandatory "code" entry.

Definition at line 57 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::code(), and dynamicCodeContext::dynamicCodeContext().

◆ localCode_

string localCode_
private

Optional "localCode" entry.

Definition at line 60 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::dynamicCodeContext(), and dynamicCodeContext::localCode().

◆ include_

string include_
private

Optional "codeInclude" entry.

Definition at line 63 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::dynamicCodeContext(), and dynamicCodeContext::include().

◆ options_

string options_
private

Optional "codeOptions" entry.

Definition at line 66 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::dynamicCodeContext(), and dynamicCodeContext::options().

◆ libs_

string libs_
private

Optional "codeLib" entry.

Definition at line 69 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::dynamicCodeContext(), and dynamicCodeContext::libs().

◆ sha1_

SHA1Digest sha1_
private

Calculated SHA1Digest.

Definition at line 72 of file dynamicCodeContext.H.

Referenced by dynamicCodeContext::dynamicCodeContext(), and dynamicCodeContext::sha1().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17