Jamoma API  0.6.0.a19
TTModelInfo Class Reference

A base class for Jamoma models. More...

#include <TTModelInfo.h>

+ Inheritance diagram for TTModelInfo:
+ Collaboration diagram for TTModelInfo:

Public Member Functions

TTErr setAddress (const TTValue &newValue)
 Atribute accessor. More...
 
TTErr Rename (const TTValue &inputValue, TTValue &outputValue)
 Rename the model. More...
 
TTErr InternalOpen ()
 Open the internal patcher. More...
 
TTErr HelpOpen ()
 Open the help page. More...
 
TTErr ReferenceOpen ()
 Open the reference file. More...
 
TTErr ReferenceWrite ()
 Write the reference file. More...
 
TTErr Mute ()
 Mute the patcher. More...
 
TTErr setAddress (const TTValue &newValue)
 Atribute accessor. More...
 
TTErr Rename (const TTValue &inputValue, TTValue &outputValue)
 Rename the model. More...
 
TTErr InternalOpen ()
 Open the internal patcher. More...
 
TTErr HelpOpen ()
 Open the help page. More...
 
TTErr ReferenceOpen ()
 Open the reference file. More...
 
TTErr ReferenceWrite ()
 Write the reference file. More...
 
TTErr Mute ()
 Mute the patcher. More...
 
- Public Member Functions inherited from TTObjectBase
virtual ~TTObjectBase ()
 Destructor.
 
TTUInt16 getReferenceCount ()
 Query an object to get its current reference count. More...
 
TTUInt32 getObserverCount () const
 Query an object to get the number of observers. More...
 
TTErr registerAttribute (const TTSymbol name, const TTDataType type, void *address)
 Register an attribute. More...
 
TTErr extendAttribute (const TTSymbol name, const TTObjectBasePtr extendedObject, const TTSymbol extendedName)
 Extend the attribute of an existing TTObjectBase to this TTObjectBase (using another attribute name) More...
 
TTErr removeAttribute (const TTSymbol name)
 Remove an attribute. More...
 
TTErr findAttribute (const TTSymbol name, TTAttribute **attr)
 Find an attribute. More...
 
TTErr setAttributeValue (const TTSymbol name, TTValue &value)
 Set an attribute value for an object. More...
 
template<class T >
TTErr set (const TTSymbol aName, T aValue)
 Set an attribute value for an object This is the same as calling setAttributeValue(). More...
 
TTErr getAttributeValue (const TTSymbol name, TTValue &value)
 Get an attribute value for an object. More...
 
template<class T >
TTErr get (const TTSymbol aName, T &aReturnedValue)
 Get an attribute value for an object This is the same as calling getAttributeValue(). More...
 
TTSymbol getAttributeType (const TTSymbol name)
 Return the type of an attribute as a symbol. More...
 
TTErr getAttributeGetterFlags (const TTSymbol name, TTAttributeFlags &value)
 Get the getterFlags of an attribute. More...
 
TTErr setAttributeGetterFlags (const TTSymbol name, TTAttributeFlags &value)
 Set the getterFlags of an attribute. More...
 
TTErr getAttributeSetterFlags (const TTSymbol name, TTAttributeFlags &value)
 Get the setterFlags of an attribute. More...
 
TTErr setAttributeSetterFlags (const TTSymbol name, TTAttributeFlags &value)
 Set the setterFlags of an attribute. More...
 
TTErr registerAttributeProperty (const TTSymbol attributeName, const TTSymbol propertyName, const TTValue &initialValue, TTGetterMethod getter, TTSetterMethod setter)
 Register an attribute property. More...
 
TTErr registerMessageProperty (const TTSymbol messageName, const TTSymbol propertyName, const TTValue &initialValue, TTGetterMethod getter, TTSetterMethod setter)
 Register an message property. More...
 
TTErr getAttribute (const TTSymbol name, TTAttributePtr *attributeObject)
 Search for and locate an attribute. More...
 
TTErr getMessage (const TTSymbol name, TTMessagePtr *messageObject)
 Search for and locate a message. More...
 
void getAttributeNames (TTValue &attributeNameList)
 Return a list of names of the available attributes. More...
 
void getMessageNames (TTValue &messageNameList)
 Return a list of names of the available messages. More...
 
TTSymbol getName () const
 Return the name of this class. More...
 
TTErr registerMessage (const TTSymbol name, TTMethod method)
 Register a message with this object. More...
 
TTErr findMessage (const TTSymbol name, TTMessage **message)
 Find a message registered with this object. More...
 
TTErr removeMessage (const TTSymbol name)
 Remove a message. More...
 
TTErr sendMessage (const TTSymbol name)
 TODO: Document this function. More...
 
TTErr registerObserverForMessage (const TTObject &observingObject, const TTSymbol messageName)
 Register an observer for a message. More...
 
TTErr registerObserverForAttribute (const TTObject &observingObject, const TTSymbol attributeName)
 Register an observer for an attribute. More...
 
TTErr registerObserverForNotifications (const TTObject &observingObject)
 Register an observer. More...
 
TTErr unregisterObserverForMessage (const TTObject &observingObject, const TTSymbol messageName)
 Unregister an observer for a message. More...
 
TTErr unregisterObserverForAttribute (const TTObject &observingObject, const TTSymbol attributeName)
 Unregister an observer for an attribute. More...
 
TTErr unregisterObserverForNotifications (const TTObject &observingObject)
 Unregister an observer for notifications. More...
 
TTErr sendNotification (const TTSymbol name, const TTValue &arguments)
 Send a notification. More...
 
TTErr logMessage (TTImmutableCString fmtstring,...)
 Log messages scoped to this object instance. More...
 
TTErr logWarning (TTImmutableCString fmtstring,...)
 Log warnings scoped to this object instance. More...
 
TTErr logError (TTImmutableCString fmtstring,...)
 Log errors scoped to this object instance. More...
 
TTErr logDebug (TTImmutableCString fmtstring,...)
 Log messages (scoped to this object instance) to output only if the basic debugging flag is enabled in the environment. More...
 
TTErr lock ()
 Lock the object in order to ensure thread-safe processing. More...
 
TTErr unlock ()
 Unlock the object when thread-safe processing is no longer required. More...
 
TTBoolean isLocked ()
 Query if the object currently is locked for thread-safe processing. More...
 
TTBoolean waitForLock ()
 If the object is locked (e.g. More...
 

Additional Inherited Members

- Public Attributes inherited from TTObjectBase
TTBoolean valid
 If the object isn't completely built, or is in the process of freeing, this will be false.
 
TTBoolean track
 enable the print of a log message to ease the track of reference counting mechanism on an instance More...
 
- Protected Member Functions inherited from TTObjectBase
 TTObjectBase (const TTValue arguments)
 Constructor. More...
 
- Protected Attributes inherited from TTObjectBase
TTList observers
 List of all objects watching this object for life-cycle and other changes.
 

Detailed Description

A base class for Jamoma models.

Definition at line 23 of file Max/source/j.model/TTModelInfo.h.

Member Function Documentation

TTErr TTModelInfo::HelpOpen ( )

Open the help page.

Returns
TTErr kTTErrNone

Definition at line 95 of file Max/source/j.model/TTModelInfo.cpp.

References jamoma_edit_filename(), kTTErrGeneric, and kTTErrNone.

+ Here is the call graph for this function:

TTErr TTModelInfo::HelpOpen ( )

Open the help page.

Returns
TTErr kTTErrNone
TTErr TTModelInfo::InternalOpen ( )

Open the internal patcher.

Returns
TTErr kTTErrNone

Definition at line 86 of file Max/source/j.model/TTModelInfo.cpp.

References jamoma_patcher_get(), and kTTErrNone.

+ Here is the call graph for this function:

TTErr TTModelInfo::InternalOpen ( )

Open the internal patcher.

Returns
TTErr kTTErrNone
TTErr TTModelInfo::Mute ( )

Mute the patcher.

Returns
TTErr kTTErrNone

Definition at line 132 of file Max/source/j.model/TTModelInfo.cpp.

References kTTErrGeneric.

TTErr TTModelInfo::Mute ( )

Mute the patcher.

Returns
TTErr kTTErrNone
TTErr TTModelInfo::ReferenceOpen ( )

Open the reference file.

Returns
TTErr kTTErrNone

Definition at line 110 of file Max/source/j.model/TTModelInfo.cpp.

References jamoma_edit_filename(), kTTErrGeneric, and kTTErrNone.

+ Here is the call graph for this function:

TTErr TTModelInfo::ReferenceOpen ( )

Open the reference file.

Returns
TTErr kTTErrNone
TTErr TTModelInfo::ReferenceWrite ( )

Write the reference file.

Returns
TTErr kTTErrNone
TTErr TTModelInfo::ReferenceWrite ( )

Write the reference file.

Returns
TTErr kTTErrNone

Definition at line 125 of file Max/source/j.model/TTModelInfo.cpp.

References kTTErrNone.

TTErr TTModelInfo::Rename ( const TTValue inputValue,
TTValue outputValue 
)

Rename the model.

Parameters
inputValuea new name.instance TTSymbol
outputValuethe effective TTSymbol name.instance
Returns
TTErr error code

Definition at line 63 of file Max/source/j.model/TTModelInfo.cpp.

References TTObject::get(), TTObject::send(), TTObjectBase::sendNotification(), and WrappedModularInstance::wrappedObject.

+ Here is the call graph for this function:

TTErr TTModelInfo::Rename ( const TTValue inputValue,
TTValue outputValue 
)

Rename the model.

Parameters
inputValuea new name.instance TTSymbol
outputValuethe effective TTSymbol name.instance
Returns
TTErr error code
TTErr TTModelInfo::setAddress ( const TTValue newValue)

Atribute accessor.

Send a filepath to the object and attempt to interface with the file.

Parameters
newValuean absolute address
Returns
TTErr kTTErrNone
TTErr TTModelInfo::setAddress ( const TTValue newValue)

Atribute accessor.

Send a filepath to the object and attempt to interface with the file.

Parameters
newValuean absolute address
Returns
TTErr kTTErrNone

Definition at line 48 of file Max/source/j.model/TTModelInfo.cpp.

References kTTErrNone, and TTObjectBase::sendNotification().

+ Here is the call graph for this function:


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