Go to the documentation of this file.
47 #ifndef functionObjects_properties_H
48 #define functionObjects_properties_H
56 namespace functionObjects
70 static const word resultsName_;
116 const word& objectName,
117 const word& entryName
133 bool setTrigger(
const label triggeri,
bool increaseOnly =
true);
138 const word& objectName,
139 const word& entryName,
147 const word& objectName,
148 const word& entryName,
149 const Type& defaultValue = Type(
Zero)
156 const word& objectName,
157 const word& entryName,
165 const word& objectName,
166 const word& entryName,
177 const word& objectName,
178 const word& entryName,
186 const word& objectName,
187 const word& entryName,
188 const Type& defaultValue = Type(
Zero)
195 const word& objectName,
196 const word& entryName,
210 const word& objectName,
211 const word& entryName
217 const word& objectName,
218 const word& entryName
Type getObjectProperty(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve generic property from named object.
bool hasObjectDict(const word &objectName) const
Return true if the object with objectName exists.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Defines the attributes of an object for which implicit objectRegistry management is supported,...
A class for handling words, derived from Foam::string.
static constexpr const zero Zero
Global zero (0)
dictionary & propertyDict(const word &objectName)
Return access to the property dictionary.
void operator=(const properties &)=delete
No copy assignment.
dictionary & getObjectDict(const word &objectName)
Get dictionary for named object. Creates one if required.
bool hasResultObject(const word &objectName) const
Return true if the object with objectName exists in results.
label getTrigger() const
Get the current trigger index.
void clearTrigger()
Remove the trigger index from the properties.
bool foundObjectProperty(const word &objectName, const word &entryName) const
Return true if the property exists.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
Type getObjectResult(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve result from named object.
void setObjectProperty(const word &objectName, const word &entryName, const Type &value)
Add generic property from named object.
properties(const properties &)=delete
No copy construct.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
OBJstream os(runTime.globalPath()/outputName)
bool setTrigger(const label triggeri, bool increaseOnly=true)
Set the trigger index. Normally only if greater than current.
virtual ~properties()=default
Destructor.
wordList objectResultNames() const
Return list of objects with results.
wordList objectNames() const
Return list of object names.
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
void writeAllResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
bool hasResultObjectEntry(const word &objectName, const word &entryName) const
void writeResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
void setObjectResult(const word &objectName, const word &entryName, const Type &value)
Add result from named object.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
wordList objectResultEntries(const word &objectName) const
Return result entries for named object.