Itasca C++ Interface
Loading...
Searching...
No Matches
common
module
interface
icontactmodellist.h
1
#pragma once
2
// icontactmodellist.h
3
4
namespace
itascaxd
{
5
class
IContactModelList
{
6
public
:
7
virtual
StringList
allModels()
const
=0;
8
// Returns a set of all properties in all contact models current registered with the program.
9
// If notFixedOnly is set to true, then *Fixed* (readOnly) properties are not returned.
10
virtual
StringList
allProperties(
const
string
&mn=
string
(),
bool
notFixedOnly=
true
)
const
=0;
11
// Return a list of properties that are not strings or vectors
12
virtual
StringList
nonStringVectorProperties(
const
string
&mn=
string
(),
bool
not_fixed_only=
true
)
const
=0;
13
// Return a list of properties that are strings only
14
virtual
StringList
stringProperties(
const
string
&mn=
string
(),
bool
not_fixed_only=
true
)
const
=0;
15
// Return a list of properties that are only vectors
16
virtual
StringList
vectorProperties(
const
string
&mn=
string
(),
bool
not_fixed_only=
true
)
const
=0;
17
// Return a property index given a model name and a property name.
18
virtual
uint32 getPropertyIndex(
const
string
&modelName,
const
string
&propertyName)=0;
19
// Returns a set of all properties in all contact models current registered with the program.
20
virtual
StringList
allMethods(
const
string
&mn=
string
())
const
=0;
21
// Return a method index given a model name and a property name.
22
virtual
uint32 getMethodIndex(
const
string
&modelName,
const
string
&propertyName)=0;
23
// Returns a list of all arguments available under the method name methodName for contact model modelName.
24
virtual
StringList
getMethodArguments(
const
string
&modelName,
const
string
&methodName)
const
=0;
25
// Returns a list of all arguments available under the method name methodName in all contact models current registered with the program.
26
virtual
StringList
getAllMethodArguments(
const
string
&methodName)
const
=0;
27
// Return true is the model was registered as a plugin
28
virtual
bool
plugin(
const
string
&name)
const
=0;
29
// Return all energies
30
virtual
StringList
allEnergies(
const
string
&mn=
string
())
const
= 0;
31
// Return the energy index
32
virtual
uint32 getEnergyIndex(
const
string
&modelName,
const
string
&energyName)=0;
33
34
};
35
}
// namespace itascaxd
36
// EoF
StringList
Definition
basestring.h:71
itascaxd::IContactModelList
Definition
icontactmodellist.h:5
itascaxd
Itasca Library standard namespace, specific to 2D or 3D.
Definition
icontactmodule.h:6
Generated by
1.10.0