Public Member Functions | Protected Member Functions | List of all members
codedBase Class Referenceabstract

Base class for function objects and boundary conditions using dynamic code. More...

Inheritance diagram for codedBase:
Inheritance graph
[legend]

Public Member Functions

 ClassName ("codedBase")
 Runtime type information. More...
 
 codedBase ()
 Construct null. More...
 
 codedBase (const codedBase &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~codedBase ()
 Destructor. More...
 
void operator= (const codedBase &)=delete
 Disallow default bitwise assignment. More...
 

Protected Member Functions

void updateLibrary (const word &name) const
 Update library as required. More...
 
virtual dlLibraryTable & libs () const =0
 Get the loaded dynamic libraries. More...
 
virtual void prepare (dynamicCode &, const dynamicCodeContext &) const =0
 Adapt the context for the current object. More...
 
virtual string description () const =0
 Return a description (type + name) for the output. More...
 
virtual void clearRedirect () const =0
 Clear any redirected objects. More...
 
virtual const dictionary & codeDict () const =0
 Get the dictionary to initialize the codeContext. More...
 
virtual const wordList & codeKeys () const =0
 Get the keywords associated with source code. More...
 

Detailed Description

Base class for function objects and boundary conditions using dynamic code.

Source files

Definition at line 53 of file codedBase.H.

Constructor & Destructor Documentation

◆ codedBase() [1/2]

codedBase ( )

Construct null.

Definition at line 349 of file codedBase.C.

◆ codedBase() [2/2]

codedBase ( const codedBase &  )
delete

Disallow default bitwise copy construction.

◆ ~codedBase()

~codedBase ( )
virtual

Destructor.

Definition at line 355 of file codedBase.C.

Member Function Documentation

◆ updateLibrary()

void updateLibrary ( const word &  name) const
protected

Update library as required.

Definition at line 284 of file codedBase.C.

References dynamicCode::checkSecurity(), dict, dynamicCodeContext::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, dynamicCode::libraryBaseName(), dictionaryName::name(), Foam::name(), dynamicCodeContext::sha1(), dictionary::startLineNumber(), and SHA1Digest::str().

Here is the call graph for this function:

◆ libs()

virtual dlLibraryTable& libs ( ) const
protectedpure virtual

Get the loaded dynamic libraries.

Implemented in codedFunctionObject, and CodedSource< Type >.

◆ prepare()

virtual void prepare ( dynamicCode &  ,
const dynamicCodeContext &   
) const
protectedpure virtual

Adapt the context for the current object.

Implemented in codedFunctionObject, and CodedSource< Type >.

◆ description()

virtual string description ( ) const
protectedpure virtual

Return a description (type + name) for the output.

Implemented in codedFunctionObject, and CodedSource< Type >.

◆ clearRedirect()

virtual void clearRedirect ( ) const
protectedpure virtual

Clear any redirected objects.

Implemented in codedFunctionObject, and CodedSource< Type >.

◆ codeDict()

virtual const dictionary& codeDict ( ) const
protectedpure virtual

Get the dictionary to initialize the codeContext.

Implemented in codedFunctionObject, and CodedSource< Type >.

◆ codeKeys()

virtual const wordList& codeKeys ( ) const
protectedpure virtual

Get the keywords associated with source code.

Implemented in codedFunctionObject, and CodedSource< Type >.

◆ ClassName()

ClassName ( "codedBase"  )

Runtime type information.

◆ operator=()

void operator= ( const codedBase &  )
delete

Disallow default bitwise assignment.

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