The functions and types in this module constitute the top level interface for the Acoustic Research Tool.

Use them to write applications of your own.

Functions
__DECLSPEC P_ART_Object __CALLCONV	ARTRootObject ()
	Create the ART root object.
__DECLSPEC bool __CALLCONV	ARTRootDestroy ()
	Destroy the ART root object.
__DECLSPEC bool __CALLCONV	ARTSetProgressFunction (TprogressFunction f)
	Define a callback function that is frequently informed about the process of the calculation.
__DECLSPEC bool __CALLCONV	ARTCheckPropertyCapability (const char property, const char capability)
	Check if a property contains a capability.
__DECLSPEC P_ART_Simulator __CALLCONV	ARTCreateSimulator (const char name, const char domain, const char *wavetype)
	Use this method to create a simulator.
__DECLSPEC bool __CALLCONV	ARTDestroySimulator (P_ART_Simulator simulator)
	Destroys a simulator.
__DECLSPEC bool __CALLCONV	ARTSetFrequencyRange (ARTsimulator *sim, double f_min, double f_max, double f_step)
	Set the frequency range of the simulator.
__DECLSPEC bool __CALLCONV	ARTSetNModes (ARTsimulator *sim, int Nmodes)
	Sets the number of modes of a simulator.
__DECLSPEC P_ART_Element __CALLCONV	ARTFindElement (P_ART_Simulator simulator, const char *name)
	Finds an element with a certain name in the simulator specified.
__DECLSPEC P_ART_Circuit __CALLCONV	ARTFindCircuit (P_ART_Simulator simulator, const char *name)
	Finds an circuit with a certain name in the simulator specified.
__DECLSPEC P_ART_Element __CALLCONV	ARTCreateElement (P_ART_Simulator simulator, const char name, const char type)
	Creates an element of a certain prototype model.
__DECLSPEC P_ART_Element __CALLCONV	ARTChangeElementModel (P_ART_Simulator simulator, P_ART_Element element, const char *type)
	Changes the model of an element.
__DECLSPEC P_ART_Object __CALLCONV	ARTGetModel (P_ART_Element element)
	Returns the model of an element.
__DECLSPEC P_ART_Element __CALLCONV	ARTChangeName (P_ART_Element element, const char *newName)
	Changes the name of an element or circuit.
__DECLSPEC bool __CALLCONV	ARTDestroyElement (P_ART_Simulator simulator, P_ART_Element element)
	Destroys an element.
__DECLSPEC P_ART_DataProp __CALLCONV	ARTSetParameter (P_ART_Simulator simulator, const char *command)
	Sets the value of parameters.
__DECLSPEC P_ART_Circuit __CALLCONV	ARTCreateCircuit (P_ART_Simulator simulator, const char *name)
	Creates an acoustic circuit.
__DECLSPEC bool __CALLCONV	ARTDestroyCircuit (P_ART_Simulator simulator, P_ART_Circuit circuit)
	Destroys a circuit.
__DECLSPEC P_ART_TModule __CALLCONV	ARTCreateTModule (P_ART_Simulator simulator, const char name, const char type)
	Creates a time simulation module.
__DECLSPEC bool __CALLCONV	ARTDestroyTModule (P_ART_Simulator simulator, P_ART_TModule module)
	Destroys a time simulation module.
__DECLSPEC bool __CALLCONV	ARTAddOPortToTModule (P_ART_TModule module, const char name, const char expr)
	Adds a new output port to the given time module.
__DECLSPEC bool __CALLCONV	ARTSetOPortOfFModule (P_ART_TModule module, int len, const char *expr)
	Sets the function output port of the given function module.
__DECLSPEC bool __CALLCONV	ARTAddLocalParamToTModule (P_ART_TModule module, const char name, const char expr)
	Adds a new local parameter to the given time module.
__DECLSPEC bool __CALLCONV	ARTAddGlobalParamToTSimulator (P_ART_Simulator simulator, const char name, const char expr)
	Adds a new global parameter to the given time simulator.
__DECLSPEC bool __CALLCONV	ARTConnectPorts (P_ART_Simulator simulator, const char *expr)
	Connects the ports of the given modules.
__DECLSPEC P_ART_DataProp __CALLCONV	ARTGetPortFromTModule (P_ART_TModule module, const char *name)
	Connects the ports of the given modules.
__DECLSPEC T_ART_Cmplx __CALLCONV	ARTGetComplexFromPort (P_ART_DataProp port, int idx)
	Calculates the output value of the given port at the specified time index.s.
__DECLSPEC int __CALLCONV	ARTGetReferencePosition (P_ART_Circuit circuit, P_ART_Element element)
	Finds the element in the circuit and returns is position.
__DECLSPEC P_ART_Object __CALLCONV	ARTAppendReference (P_ART_Circuit circuit, P_ART_Element element)
	Append the reference to an element to the end of a circuit.
__DECLSPEC P_ART_Object __CALLCONV	ARTAppendReferenceBefore (P_ART_Circuit circuit, P_ART_Element referenceAfter, P_ART_Element reference)
	Insert the reference to an element before another element into a circuit.
__DECLSPEC P_ART_Object __CALLCONV	ARTAppendReferenceAfter (P_ART_Circuit circuit, P_ART_Element referenceBefore, P_ART_Element reference)
	Insert the reference to an element after another element into a circuit.
__DECLSPEC int __CALLCONV	ARTRemoveReference (P_ART_Circuit circuit, P_ART_Element reference)
	Remove a reference to an element from a circuit.
__DECLSPEC int __CALLCONV	ARTReplaceReference (P_ART_Circuit circuit, P_ART_Element search, P_ART_Element replace)
	Replace a reference to an element with references to another element in a circuit.
__DECLSPEC int __CALLCONV	ARTRemoveAllReferences (P_ART_Circuit circuit)
	Remove all references to elements from a circuit.
__DECLSPEC P_ART_DataProp __CALLCONV	ARTInputImpedance (P_ART_Circuit circuit)
	Returns the input impedance of a circuit.
__DECLSPEC const char *__CALLCONV	ARTGetName (P_ART_Cell pobj)
	Returns the name of an object.
__DECLSPEC const char *__CALLCONV	ARTGetShortDescription (P_ART_Cell pobj)
	Returns the short description of an object.
__DECLSPEC const char *__CALLCONV	ARTGetLongDescription (P_ART_Cell pobj)
	Returns the long description of an object.
__DECLSPEC const char *__CALLCONV	ARTGetHelpFilename (P_ART_Cell pobj)
	Returns the help filename of an object.
__DECLSPEC bool __CALLCONV	ARTIsListable (P_ART_Property pprp)
	Returns true if the property is listable.
__DECLSPEC P_ART_Variant __CALLCONV	ARTGetRange (P_ART_DataProp pprp)
	Data properties can have a defined range.
__DECLSPEC bool __CALLCONV	ARTIsDataProp (P_ART_Property pprp)
	Properties and data properties are saved in the same lists in all objects.
__DECLSPEC const char *__CALLCONV	ARTGetDefinitionString (P_ART_DataProp dc)
	Returns the definition string of a data property, in the same format as it is used in the parser and in the function ARTSetParameter (see there for details on the format.) A definition string is also returned if the value of the data property has not been set using ARTSetParameter.
__DECLSPEC T_ART_Type __CALLCONV	ARTGetDatatype (P_ART_Variant pprp)
	Returns the datatype of a data property.
__DECLSPEC int __CALLCONV	ARTGetLength (P_ART_Variant pprp)
	Returns the length of a data property.
__DECLSPEC P_ART_Variant __CALLCONV	ARTGetValue (P_ART_DataProp pprp)
	Returns the value of a data property.
__DECLSPEC char *__CALLCONV	ARTGetString (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetString (P_ART_Variant pprp, int idx, const char *s)
	Set the string at index idx of the data property pointed to by pprp to s.
__DECLSPEC int __CALLCONV	ARTGetInteger (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetInteger (P_ART_Variant pprp, int idx, int i)
	Set the integer at index idx of the data property pointed to by pprp to i.
__DECLSPEC float __CALLCONV	ARTGetFloat (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetFloat (P_ART_Variant pprp, int idx, float f)
	Set the floating point value at index idx of the data property pointed to by pprp to f.
__DECLSPEC double __CALLCONV	ARTGetDouble (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetDouble (P_ART_Variant pprp, int idx, double d)
	Set the double value at index idx of the data property pointed to by pprp to d.
__DECLSPEC T_ART_Cmplx __CALLCONV	ARTGetComplex (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetComplex (P_ART_Variant pprp, int idx, T_ART_Cmplx c)
	Set the complex value at index idx of the data property pointed to by pprp to c.
__DECLSPEC T_ART_Tripl __CALLCONV	ARTGetTriple (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetTriple (P_ART_Variant pprp, int idx, T_ART_Tripl t)
	Set the triple value at index idx of the data property pointed to by pprp to t.
__DECLSPEC T_ART_Matrix __CALLCONV	ARTGetMatrix (P_ART_Variant pprp, int idx)
__DECLSPEC bool __CALLCONV	ARTSetMatrix (P_ART_Variant pprp, int idx, T_ART_Matrix m)
	Set the matrix at index idx of the data property pointed to by pprp to m.
__DECLSPEC P_ART_Property __CALLCONV	ARTFindProperty (P_ART_Object host, const char *nam)
	Find a property of an object.
__DECLSPEC P_ART_DataProp __CALLCONV	ARTFindDataProperty (P_ART_Object host, const char *nam)
	Find a data property of an object.
__DECLSPEC P_ART_Method __CALLCONV	ARTFindMethod (P_ART_Object host, const char *nam)
	Find a method of an object.
__DECLSPEC P_ART_Object __CALLCONV	ARTFindObject (P_ART_ListProp host, const char *nam)
	Find an object that is appended to another object.
__DECLSPEC P_ART_Property __CALLCONV	ARTGetProperties (P_ART_Object host, P_ART_Property pos)
	Iterates through all properties of the object host (including data properties).
__DECLSPEC P_ART_DataProp __CALLCONV	ARTGetDataProperties (P_ART_Object host, P_ART_DataProp pos)
	Iterates through all the data properties of the object host.
__DECLSPEC P_ART_Method __CALLCONV	ARTGetMethods (P_ART_Object host, P_ART_Method pos)
	Iterates through all methods of the object host.
__DECLSPEC P_ART_Object __CALLCONV	ARTGetObjects (P_ART_ListProp host, P_ART_Object pos)
	Iterates through all objects in the list host.
__DECLSPEC P_ART_DataProp __CALLCONV	ARTAppendDataProp (P_ART_Object host, P_ART_Variant val, const char nam, const char sds, const char lds, const char htm)
	Appends a data property to an ARTobject.
__DECLSPEC P_ART_ListProp __CALLCONV	ARTAppendListProp (P_ART_Object host, const char nam, const char sds, const char lds, const char htm)
	Appends a listable property to an ARTobject.
__DECLSPEC P_ART_Method __CALLCONV	ARTAppendMethod (P_ART_Object host, const char nam, const char sds, const char lds, const char htm)
	Appends a method to an ARTobject.
__DECLSPEC P_ART_Object __CALLCONV	ARTAppendObject (P_ART_ListProp host, const char nam, const char sds, const char lds, const char htm)
	Appends an object to a listable property.
__DECLSPEC bool __CALLCONV	ARTDeleteProperty (P_ART_Object host, P_ART_Property prp)
	Deletes the property prp of object host.
__DECLSPEC bool __CALLCONV	ARTDeleteMethod (P_ART_Object host, P_ART_Method mtd)
	Deletes the method mtd of object host.
__DECLSPEC bool __CALLCONV	ARTDeleteObject (P_ART_ListProp host, P_ART_Object pobj)
	Deletes the object pobj of object host.
__DECLSPEC char *__CALLCONV	ARTGetLastErrorMessage ()
	Returns the last error message.
char *__CALLCONV	ARTGetDependencyTree (P_ART_DataProp pprp, const char *linebreak)
	NEU Returns a string representation of the dependency tree.

Function Documentation

__DECLSPEC bool __CALLCONV ARTAddGlobalParamToTSimulator	(	P_ART_Simulator	simulator,
		const char *	name,
		const char *	expr
	)

Adds a new global parameter to the given time simulator.

Parameters

simulator	A pointer to the simulator to which the parameter will be added.
name	Name of the new parameter.
expr	The calculation expression of the new parameter.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTAddLocalParamToTModule	(	P_ART_TModule	module,
		const char *	name,
		const char *	expr
	)

Adds a new local parameter to the given time module.

Parameters

module	A pointer to the time module to which the parameter will be added.
name	Name of the new parameter.
expr	The calculation expression of the new parameter.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTAddOPortToTModule	(	P_ART_TModule	module,
		const char *	name,
		const char *	expr
	)

Adds a new output port to the given time module.

Parameters

module	A pointer to the time module to which the port will be added.
name	Name of the new output port.
expr	The calculation expression of the new output port.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_DataProp __CALLCONV ARTAppendDataProp	(	P_ART_Object	host,
		P_ART_Variant	val,
		const char *	nam,
		const char *	sds,
		const char *	lds,
		const char *	htm
	)

Appends a data property to an ARTobject.

Parameters

host	The object the data property should be appended to.
val	The value of the data property.
nam	The name of the data property.
sds	The short description of the data property.
lds	The long description of the data property.
htm	Filename of the html description of the data property.

Returns: A pointer to the data property appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_ListProp __CALLCONV ARTAppendListProp	(	P_ART_Object	host,
		const char *	nam,
		const char *	sds,
		const char *	lds,
		const char *	htm
	)

Appends a listable property to an ARTobject.

A listable property is an array of properties.

Parameters

host	The object the listable property should be appended to.
nam	The name of the listable property.
sds	The short description of the listable property.
lds	The long description of the listable property.
htm	Filename of the html description of the listable property.

Returns: A pointer to the listable property appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Method __CALLCONV ARTAppendMethod	(	P_ART_Object	host,
		const char *	nam,
		const char *	sds,
		const char *	lds,
		const char *	htm
	)

Appends a method to an ARTobject.

Parameters

host	The object the method should be appended to.
nam	The name of the method.
sds	The short description of the method.
lds	The long description of the method.
htm	Filename of the html description of the method.

Returns: A pointer to the method appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTAppendObject	(	P_ART_ListProp	host,
		const char *	nam,
		const char *	sds,
		const char *	lds,
		const char *	htm
	)

Appends an object to a listable property.

Parameters

host	The listable property the object should be appended to.
nam	The name of the object.
sds	The short description of the object.
lds	The long description of the object.
htm	Filename of the html description of the object.

Returns: A pointer to the object appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTAppendReference	(	P_ART_Circuit	circuit,
		P_ART_Element	element
	)

Append the reference to an element to the end of a circuit.

Parameters

circuit	A pointer to the circuit.
element	A pointer to an element or circuit to be added to this circuit.

Returns: the element appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTAppendReferenceAfter	(	P_ART_Circuit	circuit,
		P_ART_Element	referenceBefore,
		P_ART_Element	reference
	)

Insert the reference to an element after another element into a circuit.

Parameters

circuit	A pointer to the circuit.
referenceBefore	A pointer to the reference after which the element should be inserted.
reference	A pointer to an element or circuit to be inserted into this circuit.

Returns: the element appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTAppendReferenceBefore	(	P_ART_Circuit	circuit,
		P_ART_Element	referenceAfter,
		P_ART_Element	reference
	)

Insert the reference to an element before another element into a circuit.

Parameters

circuit	A pointer to the circuit.
referenceAfter	A pointer to the reference before which the element should be inserted.
reference	A pointer to an element or circuit to be inserted into this circuit.

Returns: the element appended. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Element __CALLCONV ARTChangeElementModel	(	P_ART_Simulator	simulator,
		P_ART_Element	element,
		const char *	type
	)

Changes the model of an element.

Parameters

simulator	A pointer to the simulator in which the element was created.
element	A pointer to the element.
type	The name of the prototype model you want the element to change to.

Returns: A pointer to the element. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Element __CALLCONV ARTChangeName	(	P_ART_Element	element,
		const char *	newName
	)

Changes the name of an element or circuit.

Note that expressions referring to this element like a parameter definition along the lines of "MyEl.R * 2" are not changed. If you changed the name of element "MyEl" to "Cyl", you have to redefine the defenition.

Parameters

element	A pointer to the element or circuit to be renamed.
newName	The new name.

Returns: The element renamed. When using the DLL this function will return NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

__DECLSPEC bool __CALLCONV ARTCheckPropertyCapability	(	const char *	property,
		const char *	capability
	)

Check if a property contains a capability.

Parameters

property	The property checked for the capability.
capability	A string representing the capability to be checked for.

Returns: true if the capability is found.

Exceptions

ARTerror

__DECLSPEC bool __CALLCONV ARTConnectPorts	(	P_ART_Simulator	simulator,
		const char *	expr
	)

Connects the ports of the given modules.

Parameters

simulator	A pointer to the simulator containing the related time modules.
expr	The calculation expression of the port connection. Example: "module1.in = module2.out".

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Circuit __CALLCONV ARTCreateCircuit	(	P_ART_Simulator	simulator,
		const char *	name
	)

Creates an acoustic circuit.

Parameters

simulator	The simulator within which the circuit should be created.
name	The name of the circuit.

Returns: A pointer to the created circuit. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Element __CALLCONV ARTCreateElement	(	P_ART_Simulator	simulator,
		const char *	name,
		const char *	type
	)

Creates an element of a certain prototype model.

Parameters

simulator	A pointer to the simulator in which the element should be created.
name	The name of the new element.
type	The name of the prototype model.

Returns: A pointer to the element. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Simulator __CALLCONV ARTCreateSimulator	(	const char *	name,
		const char *	domain,
		const char *	wavetype
	)

Use this method to create a simulator.

A simulator belongs to a domain of simulation in which waves of one type are calculated. It contains models of acoustic elements and arrangements of such models.

Parameters

name	The name of the simulator.
domain	The domain of the simulation. So far only frequency domain simulation is possible, so this value must be "frequency".
wavetype	The type of the simulated waves. Query the root object for possible values.

Returns: A reference to the created simulator. Using this pointer instead of the string "name" to refer to the simulator is faster and should be favoured.

Exceptions

ARTerror

__DECLSPEC P_ART_TModule __CALLCONV ARTCreateTModule	(	P_ART_Simulator	simulator,
		const char *	name,
		const char *	type
	)

Creates a time simulation module.

Parameters

simulator	The simulator within which the circuit should be created.
name	The name of the time module.
type	The type of the time module. All available types are registered as prototypes in the root object.

Returns: A pointer to the created time module. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDeleteMethod	(	P_ART_Object	host,
		P_ART_Method	mtd
	)

Deletes the method mtd of object host.

Parameters

host	A pointer to an ARTobject.
mtd	A pointer to the method whose reference should be deleted form the methods of object host.

Returns: True if a method is deleted, false otherwise. The DLL interface returns false also if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDeleteObject	(	P_ART_ListProp	host,
		P_ART_Object	pobj
	)

Deletes the object pobj of object host.

Parameters

host	A pointer to an ARTobject.
pobj	A pointer to the object whose reference should be deleted form the object-list of object host.

Returns: True if an object is deleted, false otherwise. The DLL interface returns false also if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDeleteProperty	(	P_ART_Object	host,
		P_ART_Property	prp
	)

Deletes the property prp of object host.

Parameters

host	A pointer to an ARTobject.
prp	A pointer to the property whose reference should be deleted form the properties of object host.

Returns: True if a property is deleted, false otherwise. The DLL interface returns false also if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDestroyCircuit	(	P_ART_Simulator	simulator,
		P_ART_Circuit	circuit
	)

Destroys a circuit.

Parameters

simulator	A pointer to the simulator to which the circuit belongs.
circuit	A pointer to the circuit to be destroyed.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDestroyElement	(	P_ART_Simulator	simulator,
		P_ART_Element	element
	)

Destroys an element.

Parameters

simulator	A pointer to the simulator to which the element belongs.
element	A pointer to the element to be destroyed.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDestroySimulator ( P_ART_Simulator simulator )

Destroys a simulator.

Parameters

simulator A pointer to the simulator to be destroyed.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTDestroyTModule	(	P_ART_Simulator	simulator,
		P_ART_TModule	module
	)

Destroys a time simulation module.

Parameters

simulator	A pointer to the simulator to which the circuit belongs.
module	A pointer to the time module to be destroyed.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_DataProp __CALLCONV ARTFindDataProperty	(	P_ART_Object	host,
		const char *	nam
	)

Find a data property of an object.

Parameters

host	The object in which the property will be searched.
nam	The name of the property to be searched.

Returns: A pointer to the property or NULL if no matching property was found. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Method __CALLCONV ARTFindMethod	(	P_ART_Object	host,
		const char *	nam
	)

Find a method of an object.

Parameters

host	The object in which the method will be searched.
nam	The name of the method to be searched.

Returns: A pointer to the ARTmethod or NULL if no matching method was found. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTFindObject	(	P_ART_ListProp	host,
		const char *	nam
	)

Find an object that is appended to another object.

Parameters

host	The object in which the appended object will be searched.
nam	The name of the object which you are looking for.

Returns: A pointer to the ARTobject or NULL if no matching object was found. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Property __CALLCONV ARTFindProperty	(	P_ART_Object	host,
		const char *	nam
	)

Find a property of an object.

Parameters

host	The object in which the property will be searched.
nam	The name of the property to be searched.

Returns: A pointer to the property or NULL if no matching property was found. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC T_ART_Cmplx __CALLCONV ARTGetComplex	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be read. If the property is not an array, this parameter may be omitted.

Returns: the complex value saved at index idx of the data property pointed to by prpp. Note that the DLL interface returns (0,0) if an error occurs. To make sure call ARTGetLastErrorMessage to get the error message and find out if there was an error or if the value of the data property was (0,0).

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC T_ART_Cmplx __CALLCONV ARTGetComplexFromPort	(	P_ART_DataProp	port,
		int	idx
	)

Calculates the output value of the given port at the specified time index.s.

Parameters

port	Port object, of which the timing value shall be calculated.
idx	Time index of the interested value.

Returns: T_ART_Cmplx value or <0,0> in case of an error.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_DataProp __CALLCONV ARTGetDataProperties	(	P_ART_Object	host,
		P_ART_DataProp	pos
	)

Iterates through all the data properties of the object host.

If the object is an element, only properties of the element, but not of the model are enumerated. Use ARTGetModelProperties to get the properties of the model instead.

Parameters

host	A pointer to an ARTobject
pos	A pointer to a property. This parameter is not used except for deciding if the iteration should start at the beginning. It is used to allow you to quickly cycle through all properties. Check out the example given in the documentation of ARTGetProperties.

Returns: The first property if pos is NULL, otherwise the next in the list. If the end of the list has been reached, the function returns NULL. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC T_ART_Type __CALLCONV ARTGetDatatype ( P_ART_Variant pprp )

Returns the datatype of a data property.

Parameters

pprp	A pointer to the property whose type should be returned.

Returns: The type, which is one of named constants of enumartion type T_ART_Type. The DLL interface returns C_ART_undef also if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC const char* __CALLCONV ARTGetDefinitionString ( P_ART_DataProp dc )

Returns the definition string of a data property, in the same format as it is used in the parser and in the function ARTSetParameter (see there for details on the format.) A definition string is also returned if the value of the data property has not been set using ARTSetParameter.

This function does not (yet) work with array types.

Parameters

dc	A data property whose definition should be retrieved.

Returns: A pointer to a null terminated string containing the definition. Do not change the contents of the string and do not free the associated memory.

char* __CALLCONV ARTGetDependencyTree	(	P_ART_DataProp	pprp,
		const char *	linebreak
	)

NEU Returns a string representation of the dependency tree.

This function is for debugging only and might be removed in the future.

__DECLSPEC double __CALLCONV ARTGetDouble	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be read. If the property is not an array, this parameter may be omitted.

Returns: the floating point value saved at index idx of the data property pointed to by prpp. Note that the DLL interface returns 0 if an error occurs. To make sure call ARTGetLastErrorMessage to get the error message and find out if there was an error or if the value of the data property was 0.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC float __CALLCONV ARTGetFloat	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be read. If the property is not an array, this parameter may be omitted.

Returns: the floating point value saved at index idx of the data property pointed to by prpp. Note that the DLL interface returns 0 if an error occurs. To make sure call ARTGetLastErrorMessage to get the error message and find out if there was an error or if the value of the data property was 0.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC const char* __CALLCONV ARTGetHelpFilename ( P_ART_Cell pobj )

Returns the help filename of an object.

Parameters

pobj	A pointer to the object whose help filename should be returned.

Returns: The help filename of the object. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC int __CALLCONV ARTGetInteger	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be read. If the property is not an array, this parameter may be omitted.

Returns: the integer value saved at index idx of the data property pointed to by prpp. Note that the DLL interface returns 0 if an error occurs. To make sure call ARTGetLastErrorMessage to get the error message and find out if there was an error or if the value of the data property was 0.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC char* __CALLCONV ARTGetLastErrorMessage ( )

Returns the last error message.

Use this function only when you are using the DLL interface, otherwise this function will always return an empty string. When using the header files and programming in C++, catch exceptions of type ARTerror to handle errors. Once an error message has been queried, this function returns an empty string.

Returns: a null-terminated string containing the error message with and the function where the error occured. Note that this can be a function you did not call directly.

__DECLSPEC int __CALLCONV ARTGetLength ( P_ART_Variant pprp )

Returns the length of a data property.

Parameters

pprp	A pointer to the property whose length should be returned.

Returns: The length of the property. The DLL interface returns -1 if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC const char* __CALLCONV ARTGetLongDescription ( P_ART_Cell pobj )

Returns the long description of an object.

Parameters

pobj	A pointer to the object whose long description should be returned.

Returns: The long description of the object. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC T_ART_Matrix __CALLCONV ARTGetMatrix	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be read. If the property is not an array, this parameter may be omitted.

Returns: the matrix saved at index idx of the data property pointed to by prpp. Note that the DLL interface returns a matrix with default values (all 0) if an error occurs. To make sure call ARTGetLastErrorMessage to get the error message and find out if there was an error or if the value returned is indeed that of the data property's matrix.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Method __CALLCONV ARTGetMethods	(	P_ART_Object	host,
		P_ART_Method	pos
	)

Iterates through all methods of the object host.

Parameters

host	A pointer to an ARTobject
pos	A pointer to a method. This parameter is not used except for deciding if the iteration should start at the beginning. It is used to allow you to quickly cycle through all methods. Check out the example given in the documentation of ARTGetProperties.

Returns: The first method if pos is NULL, otherwise the next in the list. If the end of the list has been reached, the function returns NULL. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTGetModel ( P_ART_Element element )

Returns the model of an element.

Use this function when you want to get information about an element's model to get a pointer to the model which you can pass on to other functions like ARTGetDataProperties.

Parameters

element A pointer to the element whose model should be retrieved.

__DECLSPEC const char* __CALLCONV ARTGetName ( P_ART_Cell pobj )

Returns the name of an object.

Parameters

pobj	A pointer to the object whose name should be returned.

Returns: The name of the object. * The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Object __CALLCONV ARTGetObjects	(	P_ART_ListProp	host,
		P_ART_Object	pos
	)

Iterates through all objects in the list host.

Parameters

host	A pointer to a list property.
pos	A pointer to an object. This parameter is not used except for deciding if the iteration should start at the beginning. It is used to allow you to quickly cycle through all objects. Check out the example given in the documentation of ARTGetProperties.

Returns: The first object if pos is NULL, otherwise the next in the list. If the end of the list has been reached, the function returns NULL. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_DataProp __CALLCONV ARTGetPortFromTModule	(	P_ART_TModule	module,
		const char *	name
	)

Connects the ports of the given modules.

Parameters

module	A pointer to the time module containing the specified port.
name	The name of the port.

Returns: The corresponding port object or NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Property __CALLCONV ARTGetProperties	(	P_ART_Object	host,
		P_ART_Property	pos
	)

Iterates through all properties of the object host (including data properties).

To find out if a property is a data property use ARTIsDataProp. If the object is an element only properties of the element itself, but not of the model of the element are enumerated. Use ARTGetModel to get a pointer to the model and pass this pointer to this function to get the properties of the model instead.

Parameters

host A pointer to an ARTobject

pos

A pointer to a property. This parameter is not used except for deciding if the iteration should start at the beginning. It is used to allow you to quickly cycle through all properties. Check out this example:

P_ART_Property prop = NULL;
while ( prop = ARTGetProperties(mySim, prop) ) 
{
        // Do some processing with prop
}

Note that the property returned is not forcefully the property following pos!

Returns: The first property if pos is NULL, otherwise the next in the list. If the end of the list has been reached, the function returns NULL. The DLL interface also returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Variant __CALLCONV ARTGetRange ( P_ART_DataProp pprp )

Data properties can have a defined range.

This function returns a pointer to an ARTvariant structure if a range for the data property is defined. Ranges are of one of the array types. Numerical ranges are defined by a minimum value at index 0 and a maximum value at index 1. The user has to ensure that the value of the data property does not violate this bounds otherwise errors will be generated when processing the data container (but not when setting the value!). For string types, the range data structure contains a list of possible strings if the set of values is restricted.

Parameters

pprp	The data property whose range should be recieved.

Returns: The range of the data property or null if no range is defined or (only when using the DLL) if there was an error.

__DECLSPEC int __CALLCONV ARTGetReferencePosition	(	P_ART_Circuit	circuit,
		P_ART_Element	element
	)

Finds the element in the circuit and returns is position.

The first element (nearest to mouth piece) of the circuit is at position 0.

Parameters

circuit	A pointer to the circuit.
element	Pointer to the element whose position is queried.

Returns: the position of the element or -1 if the element was not found. (DLL-interface: returns -1 also if another error occured)

Exceptions

ARTerror if not using the DLL interface

__DECLSPEC const char* __CALLCONV ARTGetShortDescription ( P_ART_Cell pobj )

Returns the short description of an object.

Parameters

pobj	A pointer to the object whose short description should be returned.

Returns: The short description of the object.* The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC char* __CALLCONV ARTGetString	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the string to be read. If the property is not an array, this parameter may be omitted.

Returns: the string saved at index idx of the data property pointed to by prpp. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC T_ART_Tripl __CALLCONV ARTGetTriple	(	P_ART_Variant	pprp,
		int	idx
	)

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be read. If the property is not an array, this parameter may be omitted.

Returns: the triple value saved at index idx of the data property pointed to by prpp. Note that the DLL interface returns a triple with all values set to 0 if an error occurs. To make sure call ARTGetLastErrorMessage to get the error message and find out if there was an error or if the value of the triple was (0,0,0).

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_Variant __CALLCONV ARTGetValue ( P_ART_DataProp pprp )

Returns the value of a data property.

Parameters

pprp	A pointer to the property whose value should be returned.

Returns: A pointer to the value of the property. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_DataProp __CALLCONV ARTInputImpedance ( P_ART_Circuit circuit )

Returns the input impedance of a circuit.

The impedance is evaluated as the circuit is at the moment of the function call. If the circuit is changed the function has to be called again to recalculate the impedance. Note that the value returned is a pointer to a property of the circuit. That means if you evaluate the impedance, store the pointer in a variable and then reevaluate the impedance after changing the circuit, the old pointer you have stored will point to the same data as the new pointer. If you need to compare impedances of the same circuit, you must make copies.

Parameters

circuit A pointer to the circuit whose input impedance should be returned.

Returns: The input impedance of the circuit as a pointer to an ARTvariant of type C_ART_ntri The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTIsDataProp ( P_ART_Property pprp )

Properties and data properties are saved in the same lists in all objects.

When you are not sure if a property retrieved is a data property or not, use this function to find out.

Parameters

pprp	The property to be examined.

Returns: true if pprp is a data property; false if it is a property without a value field. The DLL interface also returns false if an error was detected. Use ARTGetLastErrorMessage to get the error message.

__DECLSPEC bool __CALLCONV ARTIsListable ( P_ART_Property pprp )

Returns true if the property is listable.

If the property given is NULL, false is returned.

Parameters

pprp	A pointer to the property

Returns: true if the property is listable. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC int __CALLCONV ARTRemoveAllReferences ( P_ART_Circuit circuit )

Remove all references to elements from a circuit.

Parameters

circuit A pointer to the circuit.

Returns: the number of elements removed, 0 if no element was removed (or if there was an error when using the DLL interface. Use ARTGetLastErrorMessage to get the error message.)

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC int __CALLCONV ARTRemoveReference	(	P_ART_Circuit	circuit,
		P_ART_Element	reference
	)

Remove a reference to an element from a circuit.

Parameters

circuit	A pointer to the circuit.
reference	Pointer to the reference to be removed.

Returns: the number of elements removed, 0 if no element was removed (or if there was an error when using the DLL interface. Use ARTGetLastErrorMessage to get the error message.)

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC int __CALLCONV ARTReplaceReference	(	P_ART_Circuit	circuit,
		P_ART_Element	search,
		P_ART_Element	replace
	)

Replace a reference to an element with references to another element in a circuit.

Parameters

circuit	A pointer to the circuit.
search	Pointer to the reference to be replaced.
replace	Pointer to the reference to replace search.

Returns: the number of elements replaced, 0 if no element was replaced (or if there was an error when using the DLL interface. Use ARTGetLastErrorMessage to get the error message.)

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTRootDestroy ( )

Destroy the ART root object.

Call this function before exiting your programme to clean up memory.

__DECLSPEC P_ART_Object __CALLCONV ARTRootObject ( )

Create the ART root object.

This object contains all prototypes, simulators, methods and objects. It is created automatically in most functions and a pointer is stored internally. Do not call this method yourself.

Returns: a pointer to the root object created.

__DECLSPEC bool __CALLCONV ARTSetComplex	(	P_ART_Variant	pprp,
		int	idx,
		T_ART_Cmplx	c
	)

Set the complex value at index idx of the data property pointed to by pprp to c.

Parameters

pprp	A pointer to a data property.
idx	The index of the complex value to be written. If the property is not an array, this parameter may be omitted.
c	The complex value to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetDouble	(	P_ART_Variant	pprp,
		int	idx,
		double	d
	)

Set the double value at index idx of the data property pointed to by pprp to d.

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be written. If the property is not an array, this parameter may be omitted.
d	The value to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetFloat	(	P_ART_Variant	pprp,
		int	idx,
		float	f
	)

Set the floating point value at index idx of the data property pointed to by pprp to f.

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be written. If the property is not an array, this parameter may be omitted.
f	The value to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetFrequencyRange	(	ARTsimulator *	sim,
		double	f_min,
		double	f_max,
		double	f_step
	)

Set the frequency range of the simulator.

Parameters

sim	The simulator whose frequency should be set.
f_min	The lower frequency limit in Hz.
f_max	The higher frequency limit in Hz.
f_step	The frequency resolution used in the frequency range, in Hz.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetInteger	(	P_ART_Variant	pprp,
		int	idx,
		int	i
	)

Set the integer at index idx of the data property pointed to by pprp to i.

Parameters

pprp	A pointer to a data property.
idx	The index of the value to be written. If the property is not an array, this parameter may be omitted.
i	The value to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetMatrix	(	P_ART_Variant	pprp,
		int	idx,
		T_ART_Matrix	m
	)

Set the matrix at index idx of the data property pointed to by pprp to m.

Parameters

pprp	A pointer to a data property.
idx	The index of the matrix to be written. If the property is not an array, this parameter may be omitted.
m	The value to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetNModes	(	ARTsimulator *	sim,
		int	Nmodes
	)

Sets the number of modes of a simulator.

Parameters

sim	The simulator whose number of modes should be set.
Nmodes	The number of modes.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetOPortOfFModule	(	P_ART_TModule	module,
		int	len,
		const char *	expr
	)

Sets the function output port of the given function module.

Parameters

module	A pointer to the time module of which the port will be defined.
len	Length of the output port.
expr	The calculation expression of the output port, may be empty if values are initialized manually.

Returns: true if successful, the DLL interface returns false if an error occurs, use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC P_ART_DataProp __CALLCONV ARTSetParameter	(	P_ART_Simulator	simulator,
		const char *	command
	)

Sets the value of parameters.

Parameters

simulator The simulator to which the parameters or their models belong.

command A list of commands to set the values of parameters. If more than one command, the commands must be seperated by semicolons. A data property P of a model of an element E can always be refered to by "E.P". To change the radius of the model of the element "MyCylinder" to 12 cm, write: MyCylinder.R = 12 You can also use other properties to define one property, for example: ThyCylinder.R = MyCylinder.R * 2 Properties of the simulator can be accessed directly. To set the number of modes, write: NumberOfModes = 32 Some errors like circular references will only be detected when evaluating the property.

Returns: A pointer to the last parameter defined in the command string. The DLL interface returns NULL if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetProgressFunction ( TprogressFunction f )

Define a callback function that is frequently informed about the process of the calculation.

Parameters

f A pointer to the callback function. The function must be of type TprogressFunction. A floating point number of type double is passed to the callback function. The number indicates the progress of the current calculation. 0 means no progress, 1 means complete. If the return value of the callback function is true, the calculation is continued, otherwise it is aborted by throwing an ARTabort exception, which must be catched by the user.

Returns: void

See Also: TprogressFunction

__DECLSPEC bool __CALLCONV ARTSetString	(	P_ART_Variant	pprp,
		int	idx,
		const char *	s
	)

Set the string at index idx of the data property pointed to by pprp to s.

If the property is NULL nothing is done. If the type of the data property is not C_ART_str or C_ART_nstr nothing is done. If the index is out of bounds, nothing is done.

Parameters

pprp	A pointer to a data property.
idx	The index of the string to be written. If the property is not an array, this parameter may be omitted.
s	The string to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

__DECLSPEC bool __CALLCONV ARTSetTriple	(	P_ART_Variant	pprp,
		int	idx,
		T_ART_Tripl	t
	)

Set the triple value at index idx of the data property pointed to by pprp to t.

Parameters

pprp	A pointer to a data property.
idx	The index of the triple value to be written. If the property is not an array, this parameter may be omitted.
t	The value to be written.

Returns: true if the function is successful The DLL interface returns false if an error occurs. Use ARTGetLastErrorMessage to get the error message.

Exceptions

ARTerror if not using the DLL interface.

Functions

Function Documentation