Static Public Member Functions | |
| static bool | execute (dictionary &parentDict, Istream &is) |
| Include etc file (if it exists) in a sub-dict context. More... | |
| static bool | execute (const dictionary &parentDict, primitiveEntry &entry, Istream &is) |
| Include etc file (if it exists) in a primitiveEntry context. More... | |
 Static Public Member Functions inherited from includeEtcEntry | |
| static bool | execute (dictionary &parentDict, Istream &is) |
| Include etc file in a sub-dict context. More... | |
| static bool | execute (const dictionary &parentDict, primitiveEntry &entry, Istream &is) |
| Include etc file in a primitiveEntry context. More... | |
| Static Public Member Functions inherited from functionEntry | |
| static bool | execute (const word &functionName, dictionary &parentDict, Istream &is) |
| Execute the functionEntry in a sub-dict context. More... | |
| static bool | execute (const word &functionName, const dictionary &parentDict, primitiveEntry &entry, Istream &is) |
| Execute the functionEntry in a primitiveEntry context. More... | |
| Static Public Member Functions inherited from entry | |
| static bool | New (dictionary &parentDict, Istream &is, const inputMode inpMode=inputMode::GLOBAL, const int endChar=0) |
| Construct from an Istream and insert into the dictionary. More... | |
| static autoPtr< entry > | New (Istream &is) |
| Construct an entry from Istream. More... | |
| static void | resetInputMode () |
| Reset the globalInputMode to merge. More... | |
| Static Public Member Functions inherited from ITstream | |
| static tokenList | parse (const UList< char > &input, streamFormat format=ASCII) |
| static tokenList | parse (const std::string &input, streamFormat format=ASCII) |
| static tokenList | parse (const char *input, streamFormat format=ASCII) |
| Static Public Member Functions inherited from IOstream | |
| static unsigned int | defaultPrecision () |
| Return the default precision. More... | |
| static unsigned int | defaultPrecision (unsigned int prec) |
| Reset the default precision. More... | |
| Static Public Member Functions inherited from IOstreamOption | |
| static streamFormat | formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII) |
| static streamFormat | formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII) |
| Failsafe construct streamFormat from optional dictionary lookup. More... | |
| static compressionType | compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED) |
| The compression enum corresponding to the string. More... | |
| static compressionType | compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED) |
| Failsafe construct compressionType from optional dictionary lookup. More... | |
| Static Public Member Functions inherited from List< T > | |
| static const List< T > & | null () |
| Return a null List. More... | |
Additional Inherited Members | |
| Public Types inherited from entry | |
| enum | inputMode { MERGE, OVERWRITE, PROTECT, WARN, ERROR, GLOBAL } |
| The input mode options. More... | |
| Public Types inherited from IOstream | |
| enum | streamAccess : char { CLOSED = 0, OPENED } |
| Enumeration for stream open/closed state. More... | |
| Public Types inherited from IOstreamOption | |
| enum | streamFormat : char { ASCII = 0, BINARY } |
| Data format (ascii | binary) More... | |
| enum | compressionType : char { UNCOMPRESSED = 0, COMPRESSED } |
| Compression treatment (UNCOMPRESSED | COMPRESSED) More... | |
| Public Types inherited from List< T > | |
| typedef SubList< T > | subList |
| Declare type of subList. More... | |
| Public Member Functions inherited from functionEntry | |
| functionEntry (const word &key, const dictionary &dict, Istream &is) | |
| Construct from keyword, parent dictionary and Istream. More... | |
| declareMemberFunctionSelectionTable (bool, functionEntry, execute, dictionaryIstream,(dictionary &parentDict, Istream &is),(parentDict, is)) | |
| declareMemberFunctionSelectionTable (bool, functionEntry, execute, primitiveEntryIstream,(const dictionary &parentDict, primitiveEntry &entry, Istream &is),(parentDict, entry, is)) | |
| virtual void | write (Ostream &os) const |
| Write. More... | |
| template<class StringType > | |
| Foam::List< StringType > | readStringList (Istream &is) |
| Public Member Functions inherited from primitiveEntry | |
| primitiveEntry (const keyType &key, Istream &is) | |
| Construct from keyword and a Istream. More... | |
| primitiveEntry (const keyType &key, const dictionary &dict, Istream &is) | |
| Construct from keyword, parent dictionary and Istream. More... | |
| primitiveEntry (const keyType &key, const ITstream &is) | |
| Construct from keyword and a ITstream. More... | |
| primitiveEntry (const keyType &key, const token &tok) | |
| Construct from keyword and a single token. More... | |
| primitiveEntry (const keyType &key, const UList< token > &tokens) | |
| Construct from keyword and a list of tokens. More... | |
| primitiveEntry (const keyType &key, List< token > &&tokens) | |
| Construct from keyword and by transferring a list of tokens. More... | |
| template<class T > | |
| primitiveEntry (const keyType &key, const T &val) | |
| Construct from keyword and a T. More... | |
| autoPtr< entry > | clone (const dictionary &) const |
| Construct on freestore as copy with reference to the. More... | |
| virtual const fileName & | name () const |
| Return the dictionary name. More... | |
| virtual fileName & | name () |
| Return the dictionary name. More... | |
| virtual label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| virtual label | endLineNumber () const |
| Return line number of last token in dictionary. More... | |
| virtual bool | isStream () const |
| Return true - this entry is a stream. More... | |
| virtual ITstream & | stream () const |
| Return token stream for this primitive entry. More... | |
| virtual const dictionary & | dict () const |
| This entry is not a dictionary,. More... | |
| virtual dictionary & | dict () |
| This entry is not a dictionary,. More... | |
| virtual bool | read (const dictionary &dict, Istream &is) |
| Read tokens from the given stream. More... | |
| void | write (Ostream &os, const bool contentsOnly) const |
| Write, optionally with contents only (no keyword, etc) More... | |
| InfoProxy< primitiveEntry > | info () const |
| Return info proxy. More... | |
| virtual Istream & | read (token &tok) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (char &) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (word &) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (string &) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (label &) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (floatScalar &) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (doubleScalar &) |
| Inherit read from ITstream. More... | |
| virtual Istream & | read (char *data, std::streamsize) |
| Inherit read from ITstream. More... | |
| Public Member Functions inherited from entry | |
| entry (const keyType &keyword) | |
| Construct from keyword. More... | |
| entry (const entry &e) | |
| Construct as copy. More... | |
| virtual autoPtr< entry > | clone () const |
| Construct on freestore as copy. More... | |
| virtual | ~entry ()=default |
| Destructor. More... | |
| const keyType & | keyword () const |
| Return keyword. More... | |
| keyType & | keyword () |
| Return non-const access to keyword. More... | |
| virtual bool | isDict () const |
| Return true if this entry is a dictionary. More... | |
| virtual const dictionary * | dictPtr () const |
| Return pointer to dictionary, if entry is a dictionary. More... | |
| virtual dictionary * | dictPtr () |
| Return non-const pointer to dictionary, if entry is a dictionary. More... | |
| void | checkITstream (const ITstream &is) const |
| template<class T > | |
| T | get () const |
| template<class T > | |
| void | readEntry (T &val) const |
| template<class T , class Predicate > | |
| T | getCheck (const Predicate &pred) const |
| template<class T , class Predicate > | |
| void | readCheck (T &val, const Predicate &pred) const |
| void | operator= (const entry &e) |
| bool | operator== (const entry &e) const |
| bool | operator!= (const entry &e) const |
| Public Member Functions inherited from ITstream | |
| ITstream (const ITstream &is) | |
| Copy construct. More... | |
| ITstream (const string &name, const UList< token > &tokens, streamFormat format=ASCII, versionNumber version=currentVersion) | |
| Construct from components. More... | |
| ITstream (const string &name, List< token > &&tokens, streamFormat format=ASCII, versionNumber version=currentVersion) | |
| Construct from components, transferring the tokens. More... | |
| ITstream (const string &name, const UList< char > &input, streamFormat format=ASCII, versionNumber version=currentVersion) | |
| Construct token list by parsing the input character sequence. More... | |
| ITstream (const string &name, const std::string &input, streamFormat format=ASCII, versionNumber version=currentVersion) | |
| Construct token list by parsing the input string. More... | |
| ITstream (const string &name, const char *input, streamFormat format=ASCII, versionNumber version=currentVersion) | |
| Construct token list by parsing the input character sequence. More... | |
| virtual | ~ITstream ()=default |
| Destructor. More... | |
| label | tokenIndex () const |
| The current token index when reading, or the insertion point. More... | |
| label & | tokenIndex () |
| Non-const access to the current token index. More... | |
| label | nRemainingTokens () const |
| The number of remaining tokens. More... | |
| ios_base::fmtflags | flags () const |
| Return flags of output stream. More... | |
| virtual Istream & | read (token &tok) |
| Return next token from stream. More... | |
| virtual Istream & | read (char &) |
| Read a character. More... | |
| virtual Istream & | read (word &) |
| Read a word. More... | |
| virtual Istream & | read (string &) |
| Read a string (including enclosing double-quotes) More... | |
| virtual Istream & | read (label &) |
| Read a label. More... | |
| virtual Istream & | read (floatScalar &) |
| Read a floatScalar. More... | |
| virtual Istream & | read (doubleScalar &) |
| Read a doubleScalar. More... | |
| virtual Istream & | read (char *data, std::streamsize) |
| Read binary block. More... | |
| virtual Istream & | readRaw (char *data, std::streamsize count) |
| Low-level raw binary read. More... | |
| virtual bool | beginRawRead () |
| Start of low-level raw binary read. More... | |
| virtual bool | endRawRead () |
| End of low-level raw binary read. More... | |
| virtual void | rewind () |
| Rewind the stream so that it may be read again. More... | |
| void | seek (label pos) |
| Move the tokenIndex to the specified position. More... | |
| void | append (const token &t, const bool lazy) |
| void | append (token &&t, const bool lazy) |
| void | append (const tokenList &newTokens, const bool lazy) |
| void | append (tokenList &&newTokens, const bool lazy) |
| ios_base::fmtflags | flags (const ios_base::fmtflags) |
| Set flags of stream. More... | |
| void | print (Ostream &os) const |
| Print stream description to Ostream. More... | |
| std::string | toString () const |
| void | operator= (const ITstream &is) |
| Copy assignment, with rewind() More... | |
| void | operator= (const tokenList &toks) |
| Copy assignment of tokens, with rewind() More... | |
| void | operator= (tokenList &&toks) |
| Move assignment of tokens, with rewind() More... | |
| Public Member Functions inherited from Istream | |
| Istream (const Istream &)=default | |
| Copy construct. More... | |
| virtual | ~Istream ()=default |
| Destructor. More... | |
| Istream (IOstreamOption streamOpt=IOstreamOption()) | |
| Istream (streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED) | |
| Construct with format, version (compression) More... | |
| void | putBack (const token &tok) |
| Put back token. More... | |
| bool | getBack (token &tok) |
| Get the put back token if there is one and return true. More... | |
| bool | peekBack (token &tok) |
| Peek at the put back token without removing it. More... | |
| bool | readBegin (const char *funcName) |
| Begin read of data chunk, starts with '('. More... | |
| bool | readEnd (const char *funcName) |
| End read of data chunk, ends with ')'. More... | |
| char | readBeginList (const char *funcName) |
| Begin read of list data, starts with '(' or '{'. More... | |
| char | readEndList (const char *funcName) |
| End read of list data, ends with ')' or '}'. More... | |
| Istream & | operator() () const |
| Return a non-const reference to const Istream. More... | |
| Public Member Functions inherited from IOstream | |
| IOstream (const IOstream &)=default | |
| Copy construct. More... | |
| virtual | ~IOstream ()=default |
| Destructor. More... | |
| IOstream (IOstreamOption streamOpt=IOstreamOption()) | |
| IOstream (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) | |
| Construct with format, version (compression) More... | |
| virtual bool | check (const char *operation) const |
| Check IOstream status for given operation. More... | |
| bool | fatalCheck (const char *operation) const |
| Check IOstream status for given operation. More... | |
| bool | opened () const |
| Return true if stream has been opened. More... | |
| bool | closed () const |
| Return true if stream is closed. More... | |
| bool | good () const |
| Return true if next operation might succeed. More... | |
| bool | eof () const |
| Return true if end of input seen. More... | |
| bool | fail () const |
| Return true if next operation will fail. More... | |
| bool | bad () const |
| Return true if stream is corrupted. More... | |
| operator bool () const | |
| Return true if the stream has not failed. More... | |
| bool | operator! () const |
| Return true if the stream has failed. More... | |
| unsigned | labelByteSize () const |
| The label byte-size associated with the stream. More... | |
| unsigned | scalarByteSize () const |
| The scalar byte-size associated with the stream. More... | |
| void | setLabelByteSize (unsigned nbytes) |
| Set the label byte-size associated with the stream. More... | |
| void | setScalarByteSize (unsigned nbytes) |
| Set the scalar byte-size associated with the stream. More... | |
| template<class T = label> | |
| std::enable_if< std::is_integral< T >::value, bool >::type | checkLabelSize () const |
| template<class T = scalar> | |
| std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const |
| label | lineNumber () const |
| Const access to the current stream line number. More... | |
| label & | lineNumber () |
| Non-const access to the current stream line number. More... | |
| label | lineNumber (const label num) |
| Set the stream line number. More... | |
| void | setEof () |
| Set stream to have reached eof. More... | |
| void | setFail () |
| Set stream to have failed. More... | |
| void | setBad () |
| Set stream to be bad. More... | |
| ios_base::fmtflags | setf (const ios_base::fmtflags f) |
| Set flags of stream. More... | |
| ios_base::fmtflags | setf (const ios_base::fmtflags f, const ios_base::fmtflags mask) |
| Set flags of given field of stream. More... | |
| void | unsetf (const ios_base::fmtflags f) |
| Unset flags of stream. More... | |
| void | print (Ostream &os, const int streamState) const |
| Print information about the stream state bits. More... | |
| InfoProxy< IOstream > | info () const |
| Return info proxy. More... | |
| Public Member Functions inherited from IOstreamOption | |
| constexpr | IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
| constexpr | IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept |
| Construct from components (format, compression, version) More... | |
| constexpr | IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
| Construct from components (format, version, compression) More... | |
| IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept | |
| Copy construct with change of format. More... | |
| streamFormat | format () const noexcept |
| Get the current stream format. More... | |
| streamFormat | format (const streamFormat fmt) noexcept |
| Set the stream format. More... | |
| streamFormat | format (const word &formatName) |
| Set the stream format from string value. More... | |
| compressionType | compression () const noexcept |
| Get the stream compression. More... | |
| compressionType | compression (const compressionType comp) noexcept |
| Set the stream compression. More... | |
| compressionType | compression (const word &compName) |
| Set the stream compression from string value. More... | |
| versionNumber | version () const noexcept |
| Get the stream version. More... | |
| versionNumber | version (const versionNumber ver) noexcept |
| Set the stream version. More... | |
| versionNumber | version (const token &tok) |
| Set the stream version from token. More... | |
| Public Member Functions inherited from List< T > | |
| constexpr | List () noexcept |
| Null constructor. More... | |
| List (const label len) | |
| Construct with given size. More... | |
| List (const label len, const T &val) | |
| Construct with given size and value for all elements. More... | |
| List (const label len, const zero) | |
| Construct with given size initializing all elements to zero. More... | |
| List (const one, const T &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| List (const one, T &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| List (const one, const zero) | |
| Construct with length=1, initializing content to zero. More... | |
| List (const List< T > &a) | |
| Copy construct from list. More... | |
| List (const UList< T > &a) | |
| Copy construct contents from list. More... | |
| List (List< T > &a, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< T > &list, const labelUList &indices) | |
| Copy construct subset of list. More... | |
| template<unsigned N> | |
| List (const UList< T > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. More... | |
| template<class InputIterator > | |
| List (InputIterator begIter, InputIterator endIter) | |
| Construct given begin/end iterators. More... | |
| template<unsigned N> | |
| List (const FixedList< T, N > &list) | |
| Construct as copy of FixedList<T, N> More... | |
| List (const PtrList< T > &list) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< T > &list) | |
| Construct as copy of SLList<T> More... | |
| template<class Addr > | |
| List (const IndirectListBase< T, Addr > &list) | |
| Construct as copy of IndirectList contents. More... | |
| List (std::initializer_list< T > list) | |
| Construct from an initializer list. More... | |
| List (List< T > &&list) | |
| Move construct from List. More... | |
| template<int SizeMin> | |
| List (DynamicList< T, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| List (SortableList< T > &&list) | |
| Move construct from SortableList. More... | |
| List (SLList< T > &&list) | |
| Move construct from SLList. More... | |
| List (Istream &is) | |
| Construct from Istream. More... | |
| autoPtr< List< T > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | resize (const label newSize) |
| Adjust allocated size of list. More... | |
| void | resize (const label newSize, const T &val) |
| Adjust allocated size of list and set val for new elements. More... | |
| void | setSize (const label newSize) |
| Alias for resize(const label) More... | |
| void | setSize (const label newSize, const T &val) |
| Alias for resize(const label, const T&) More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | append (const T &val) |
| Append an element at the end of the list. More... | |
| void | append (T &&val) |
| Move append an element at the end of the list. More... | |
| void | append (const UList< T > &list) |
| Append a List to the end of this list. More... | |
| template<class Addr > | |
| void | append (const IndirectListBase< T, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| void | transfer (List< T > &list) |
| template<int SizeMin> | |
| void | transfer (DynamicList< T, SizeMin > &list) |
| void | transfer (SortableList< T > &list) |
| T & | newElmt (const label i) |
| void | operator= (const UList< T > &a) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< T > &list) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const SLList< T > &list) |
| Assignment to SLList operator. Takes linear time. More... | |
| template<class Addr > | |
| void | operator= (const IndirectListBase< T, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More... | |
| template<unsigned N> | |
| void | operator= (const FixedList< T, N > &list) |
| Copy assignment from FixedList. More... | |
| void | operator= (std::initializer_list< T > list) |
| Assignment to an initializer list. More... | |
| void | operator= (const T &val) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| void | operator= (List< T > &&list) |
| Move assignment. Takes constant time. More... | |
| template<int SizeMin> | |
| void | operator= (DynamicList< T, SizeMin > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (SortableList< T > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (SLList< T > &&list) |
| Move assignment. Takes constant time. More... | |
| void | shallowCopy (const UList< T > &)=delete |
| No shallowCopy permitted. More... | |
| template<class TypeT = T> | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. More... | |
| template<> | |
| void | resize (const label newSize) |
| Static Public Attributes inherited from includeEtcEntry | |
| static bool | log |
| Report to stdout which file is included. More... | |
| Static Public Attributes inherited from entry | |
| static int | disableFunctionEntries |
| Enable or disable use of function entries and variable expansions. More... | |
| static inputMode | globalInputMode = inputMode::MERGE |
| The current global input-mode. More... | |
| Static Public Attributes inherited from IOstream | |
| static unsigned int | precision_ |
| Default precision. More... | |
| Static Public Attributes inherited from IOstreamOption | |
| static const Enum< streamFormat > | formatNames |
| Stream format names (ascii, binary) More... | |
| static const versionNumber | currentVersion |
| The current version number (2.0) More... | |
| Protected Member Functions inherited from IOstream | |
| void | setOpened () |
| Set stream opened. More... | |
| void | setClosed () |
| Set stream closed. More... | |
| void | setState (ios_base::iostate state) |
| Set stream state. More... | |
| void | setGood () |
| Set stream to be good. More... | |
| Static Protected Member Functions inherited from includeEtcEntry | |
| static fileName | resolveEtcFile (const fileName &f, const dictionary &dict) |
| Expand include fileName and search etc directories for the file. More... | |
| static bool | execute (const bool mandatory, dictionary &parentDict, Istream &is) |
| Include file in a sub-dict context. More... | |
| static bool | execute (const bool mandatory, const dictionary &parentDict, primitiveEntry &entry, Istream &is) |
| Include file in a primitiveEntry context. More... | |
| Static Protected Member Functions inherited from functionEntry | |
| static token | readLine (const word &key, Istream &is) |
| Read line and return as a string token. More... | |
| template<class StringType > | |
| static List< StringType > | readStringList (Istream &is) |
| Protected Attributes inherited from IOstream | |
| streamAccess | openClosed_ |
| ios_base::iostate | ioState_ |
| unsigned short | labelByteSize_ |
| The label byte-size (could also be stored as byte) More... | |
| unsigned short | scalarByteSize_ |
| The scalar byte-size (could also be stored as byte) More... | |
| label | lineNumber_ |
| The file line. More... | |
| Static Protected Attributes inherited from IOstream | |
| static fileName | staticName_ |
| Name for any generic stream - normally treat as readonly. More... | |
A dictionary directive for conditionally including an etc file, expects a single string to follow.
The #sincludeEtc directive is identically to the #includeEtc directive, but does not generate an error if the file does not exist.
Definition at line 133 of file includeEtcEntry.H.
|
static |
Include etc file (if it exists) in a sub-dict context.
Definition at line 212 of file includeEtcEntry.C.
|
static |
Include etc file (if it exists) in a primitiveEntry context.
Definition at line 222 of file includeEtcEntry.C.
1.8.17 