SoTimeCounter Class Reference

Timed integer counter. More...

#include <Inventor/engines/SoTimeCounter.h>

Inheritance diagram for SoTimeCounter:

Public Attributes
Inputs
SoSFShort	min
	Minimum value for the counter.
SoSFShort	max
	Maximum value for the counter.
SoSFShort	step
	Counter step value.
SoSFBool	on
	Counter pauses if this is set to FALSE.
SoSFFloat	frequency
	Number of min -to-max cycles per second.
SoMFFloat	duty
	Duty cycle values.
SoSFTime	timeIn
	Running time.
SoSFTrigger	syncIn
	Restart at the beginning of the cycle.
SoSFShort	reset
	Reset the counter to the specified value.

Outputs
SoEngineOutput	output
	Counts min -to-max , in step increments.
SoEngineOutput	syncOut
	Triggers at cycle start.
	SoTimeCounter ()
	Constructor.
static void	initClass ()
virtual void	inputChanged (SoField *whichInput)
	This is called whenever the value of an input is changed.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput.
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance.

Additional Inherited Members
Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.
SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a pointer to the engine output with the given name.
bool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in outputName) the name of the engine output (output).
SoEngine *	copy () const
	Creates and returns an exact copy of the engine.
void	evaluateWrapper ()
	wrapper for the user's evaluate() engine
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
virtual const SoEngineOutputData *	getOutputData () const =0
	Info on outputs:
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)
virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.
bool	shouldCopy () const
	Recursive procedure that determines if this engine should be copied during a copy operation, or just referenced as is.
bool	isNotifying () const
	A very annoying double notification occurs with engines that enable their outputs during inputChanged; this flag prevents that:
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
bool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.
bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
bool	set (const char *fieldDataString, SoInput *dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)
bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.
virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.
virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.
void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.
Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.
void	unref () const
void	unrefNoDelete () const
void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.
bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
virtual void	startNotify ()
	Initiates notification from an instance.
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.
void	removeAuditor (void *auditor, SoNotRec::Type type)
const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
int	getRefCount () const
	Returns current reference count.
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.
bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.
static SoEngine *	getByName (const SbName &name)
	Look up engine(s) by name.
static int	getByName (const SbName &name, SoEngineList &list)
	Look up engine(s) by name.
static void	initClass ()
	Initializes base engine class.
static void	initClasses ()
	Initialize ALL Inventor engine classes.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
static void	initClass ()
	Setup type information.
static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
static void	addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
	Adds an instance to the dictionary.
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.
static void	copyDone ()
	Cleans up the dictionary when done.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
static void	initClass ()
	Setup type information.
static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.
static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.
static void	addName (SoBase *, const char *)
	Internal methods used to maintain the global name dictionary.
static void	removeName (SoBase *, const char *)
static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.
static int	getNamedBases (const SbName &, SoBaseList &, SoType)
static bool	read (SoInput *in, SoBase *&base, SoType expectedType)
	Reads one instance of some subclass of SoBase.
static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...
Protected Member Functions inherited from SoEngine
virtual void	evaluate ()=0
	User-written evaluation engine.
	SoEngine ()
	Constructor, destructor.
	~SoEngine ()
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.
virtual void	inputChanged (SoField *whichField)
	This is called whenever the value of an input is changed.
void	writeOutputTypes (SoOutput *out)
	Write output type information for engines that are not built-in.
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()
	~SoFieldContainer ()
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.
Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.
virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.
virtual void	destroy ()
	Actually deletes an instance.
bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.
bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
void	writeFooter (SoOutput *out) const
virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)
virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.
Static Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr ()
	This is used by the input&output inheritence mechanism, hidden in the SoSubEngine macros.
static const SoEngineOutputData **	getOutputDataPtr ()
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.
Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Detailed Description

This engine is a counter that outputs numbers, starting at a minimum value, increasing by a step value, and ending with a number that does not exceed the maximum value. When the maximum number is reached, it starts counting from the beginning again.

The difference between this engine and the SoCounter engine, is that this engine also has a timeIn input, which allows the counting cycles to be timed. This engine counts automatically over time; it does not need to be triggered to go to the next step. By default, the timeIn input is connected to the realTime global field.
It can, however, be connected to any time source.

The frequency input field controls how many min-to-max cycles are performed per second. For example, a frequency value of 0.5 means that it will take 2 seconds to complete a single min-to-max cycle.

The steps in the count cycle do not necessarily all have the same duration. Using the duty input field, you can arbitrarily split the time period of the count cycle between the steps. For example, if there are 5 steps in the cycle, a duty input of (1., 2., 2., 2., 1.) will make the second, third, and fourth steps take twice as long as the first and last steps.

At any time the counter can be reset to a specific value. If you set the reset input field to a value, the engine will continue counting from there. Note that the counter will always output numbers based on the min , max and step values, and setting the reset value does not affect the those input fields. If the reset value is not a legal counter value, the counter will still behave as though it is:

If reset is greater than max, the counter is set to max.
If reset is less than min, the counter is set to min.
If reset is between step values, the counter is set to the lower step.

Each time a counting cycle is started, the syncOut output is triggered.
This output can be used to synchronize some other event with the counting cycle. Other events can also synchronize the counter by triggering the syncIn input.

You can pause the engine, by setting the on input to FALSE, and it will stop updating the output field. When you turn off the pause, by setting on to TRUE, it will start counting again from where it left off.

File Format/Default

TimeCounter {
  min 0
  max 1
  step 1
  on TRUE
  frequency 1
  duty 1
  timeIn 1316437066.463
  reset 0
}

See Also

SoCounter, SoElapsedTime, SoEngineOutput

Definition at line 148 of file SoTimeCounter.h.

Constructor & Destructor Documentation

SoTimeCounter()

SoTimeCounter::SoTimeCounter

(

)

Member Function Documentation

initClass()

static void SoTimeCounter::initClass ( )

static

inputChanged()

virtual void SoTimeCounter::inputChanged ( SoField *  whichField )

protectedvirtual

The default method does nothing. Subclasses can override this to detect when a specific field is changed.

Reimplemented from SoEngine.

readInstance()

virtual bool SoTimeCounter::readInstance ( SoInput *  in, unsigned short  flags  )

protectedvirtual

Works around a problem with old files that contain explicit references to the default connection to realTime.

Reimplemented from SoEngine.

writeInstance()

virtual void SoTimeCounter::writeInstance ( SoOutput *  out )

protectedvirtual

Takes care of not writing out connection to realTime that is created in constructor.

Reimplemented from SoEngine.

Member Data Documentation

duty

SoMFFloat SoTimeCounter::duty

Definition at line 172 of file SoTimeCounter.h.

frequency

SoSFFloat SoTimeCounter::frequency

Definition at line 169 of file SoTimeCounter.h.

max

SoSFShort SoTimeCounter::max

Definition at line 160 of file SoTimeCounter.h.

min

SoSFShort SoTimeCounter::min

Definition at line 157 of file SoTimeCounter.h.

on

SoSFBool SoTimeCounter::on

Definition at line 166 of file SoTimeCounter.h.

output

SoEngineOutput SoTimeCounter::output

Definition at line 189 of file SoTimeCounter.h.

reset

SoSFShort SoTimeCounter::reset

Definition at line 181 of file SoTimeCounter.h.

step

SoSFShort SoTimeCounter::step

Definition at line 163 of file SoTimeCounter.h.

syncIn

SoSFTrigger SoTimeCounter::syncIn

Definition at line 178 of file SoTimeCounter.h.

syncOut

SoEngineOutput SoTimeCounter::syncOut

Definition at line 192 of file SoTimeCounter.h.

timeIn

SoSFTime SoTimeCounter::timeIn

Definition at line 175 of file SoTimeCounter.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/engines/SoTimeCounter.h